@canopycanopycanopy/b-ber-reader-react 1.2.13-media-queries.60

package/LICENSE.md

@@ -0,0 +1,16 @@
+b-ber is a toolchain for creating publications in a variety of digital
+formats
+Copyright (C) 2018 Triple Canopy
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.

package/README.md

@@ -0,0 +1,34 @@
+# `@canopycanopycanopy/b-ber-reader-react`
+
+The `b-ber-reader-react` package contains the source code for the `b-ber-reader` package.
+
+## Install
+
+```
+$ npm i -g @canopycanopycanopy/b-ber-reader-react
+```
+
+## Develop
+
+Serve the app in the **dev** directory.
+
+Rename **index.example.js** **index.js**, update the `Reader` props with a valid `bookURL` or `manifestURL`, and run
+
+```
+npm serve
+```
+
+The `serve` script will run a Webpack dev server and inject updates when changes are made in the **src** directory.
+
+## Customize
+
+Extend the **config.development.js** and **config.production.js** files in the **webpack** directory.
+
+Pass in the custom configuration file as an argument to the **package.json** scripts, e.g.,
+
+```
+npm watch webpack/config.custom.js
+npm build webpack/config.custom.js
+```
+
+See **config.custom-example.js** for example implementation.