diff --git a/README.md b/README.md index a68364386aad8aef5a074697dea0fea0ea6baac5..3081cc045533e031045332c39568d5a1f6ef1e82 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,6 @@ -## 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: +## Running Mirador locally 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 `m3core.umd.js` and is placed in the `dist` directory. -1. Open a nodejs console (type `node`) in this directory. -1. Import variable names from the module, for example, `let { store, actions } = 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 `let state = require('./index.umd').store`. ## Starting the project @@ -17,6 +10,17 @@ $ npm start Then navigate to [http://127.0.0.1:4444/__tests__/integration/mirador/](http://127.0.0.1:4444/__tests__/integration/mirador/) +### Instantiating Mirador + +```javascript +var miradorInstance = Mirador.viewer({ + id: 'mirador' // id selector where Mirador should be instantiated +}); + +> miradorInstance +{ actions, store } +``` + ### Example Action Add a window: @@ -39,7 +43,7 @@ store.getState() ## Running the tests ```sh -$ npm test +$ npm test # For headless CI=true npm test ``` or to continually watch the source files @@ -55,7 +59,6 @@ $ npm run lint ``` ## Debugging - -### Redux DevTools - -This is a web browser extension for debugging Redux applications. See https://github.com/zalmoxisus/redux-devtools-extension for installation and usage instructions. +Useful browser extensions for debugging/development purposes + - [React DevTools](https://github.com/facebook/react-devtools) + - [Redux DevTools](https://github.com/zalmoxisus/redux-devtools-extension)