@canopycanopycanopy/b-ber-reader-react 1.2.13-react-reader.20 → 1.2.13-react-reader.31

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.
package/README.md CHANGED
@@ -7,3 +7,28 @@ The `b-ber-reader-react` package contains the source code for the `b-ber-reader`
7
7
  ```
8
8
  $ npm i -g @canopycanopycanopy/b-ber-reader-react
9
9
  ```
10
+
11
+ ## Develop
12
+
13
+ Serve the app in the **dev** directory.
14
+
15
+ Rename **index.example.js** **index.js**, update the `Reader` props with a valid `bookURL` or `manifestURL`, and run
16
+
17
+ ```
18
+ npm serve
19
+ ```
20
+
21
+ The `serve` script will run a Webpack dev server and inject updates when changes are made in the **src** directory.
22
+
23
+ ## Customize
24
+
25
+ Extend the **config.development.js** and **config.production.js** files in the **webpack** directory.
26
+
27
+ Pass in the custom configuration file as an argument to the **package.json** scripts, e.g.,
28
+
29
+ ```
30
+ npm watch webpack/config.custom.js
31
+ npm build webpack/config.custom.js
32
+ ```
33
+
34
+ See **config.custom-example.js** for example implementation.