@canopycanopycanopy/b-ber-reader 3.0.8-nav.0 → 3.0.8-next.96

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +20 -4
  2. package/dist/assets/index-DFFa52lz.css +1 -0
  3. package/dist/assets/index-DFSComeg.js +92 -0
  4. package/dist/index.html +30 -1
  5. package/package.json +11 -21
  6. package/dist/0c35d18bf06992036b691da73d635fc4.woff2 +0 -0
  7. package/dist/4d73cb90e394b34b767077d75cce0c4c.woff +0 -0
  8. package/dist/737fa3c878dc13e7c16c6c2503890888.ttf +0 -0
  9. package/dist/7609101514b0166981d789f88c7d87f3.ttf +0 -0
  10. package/dist/main.14efec8402633645287b.js +0 -2
  11. package/dist/main.14efec8402633645287b.js.LICENSE.txt +0 -32
package/README.md CHANGED
@@ -1,9 +1,25 @@
1
1
  # `@canopycanopycanopy/b-ber-reader`
2
2
 
3
- The `b-ber-reader` package is used to render a horizontally scrolling HTML view in a browser. It includes a user-interface to navigate through a published project, display a project metadata, and to download related project assets. This package contains the compiled source of the `@canopycanopycanopy/b-ber-reader-react` package.
3
+ `b-ber-reader` is a thin webpack-based wrapper that bundles `@canopycanopycanopy/b-ber-reader-react` into a standalone browser application. It contains no reader logic of its own; `src/index.js` mounts the React reader component from `b-ber-reader-react` onto a `#root` element, seeding it with optional `window.__SERVER_DATA__` props. A companion Express server (`server.js`) scans an `epub/` directory, builds a book manifest, serves it at `/api/books.json`, and acts as a static host for the compiled `dist/` bundle — enabling local preview of multiple compiled b-ber projects. This package is considered the deployment shell for the reader; prefer `b-ber-reader-react` for any reader feature work.
4
4
 
5
- ## Install
5
+ ## Architecture
6
6
 
7
+ | Component | Description |
8
+ | ------------------- | ---------------------------------------------------------------------- |
9
+ | `src/index.js` | Entry point — mounts `<Reader>` from `b-ber-reader-react` |
10
+ | `src/template.ejs` | HTML shell template used by HtmlWebpackPlugin |
11
+ | `webpack.config.js` | Production bundle config; outputs to `dist/` |
12
+ | `server.js` | Express dev server; scans `epub/` and serves a book manifest |
13
+ | `index.js` | Package main — empty stub (reader logic lives in `b-ber-reader-react`) |
14
+
15
+ The webpack build resolves `react` and `react-dom` from the monorepo root to
16
+ avoid duplicate React instances when `b-ber-reader-react` is symlinked.
17
+
18
+ ## Dev
19
+
20
+ ```bash
21
+ npm run build # webpack production build → dist/
22
+ npm run serve # build then start the Express server (nodemon)
7
23
  ```
8
- $ npm i -g @canopycanopycanopy/b-ber-reader
9
- ```
24
+
25
+ No tests are currently implemented (`npm test` echoes "TODO tests").