diff --git a/README.md b/README.md index dc782211cd40627c4a3e05c1a7a7cdb73bb7cc47..340344cb6a9528402584e1b3fd9a616b2959f59e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ -** Running the module ** +## Running the module This module is intended to be a console-only version of the a Mirador-like viewer, with tests and the ability to manipulate the state tree through actions in the console. To run the module, first make sure you are in this directory (`minimal_redux_poc`), then: +1. Run `npm install` to install the dependencies. 1. Run the `npm run build:umd` task. This will produce an "isomorphic" webpack bundle of the module that can run in the console or browser. The bundle will be called `index.umd.js` and is placed in this same directory. -2. Open a nodejs console (type `node`) in this directory. -3. Require the module under a variable name, for example, `state = require('./index.umd')`. -4. The exported module currently has most of its functionality under the "store" property, so you may prefer to include it with `state = require('./index.umd').store`. +1. Open a nodejs console (type `node`) in this directory. +1. Require the module under a variable name, for example, `state = require('./index.umd')`. +1. The exported module currently has most of its functionality under the "store" property, so you may prefer to include it with `state = require('./index.umd').store`. -Example Action +### Example Action To increment the canvas index run: