Skip to content

Commit

Permalink
Readme update. Short instructions to start docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
liesislukas committed Nov 15, 2015
1 parent 63a1c87 commit e476893
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,16 @@ The project is being initially developed and maintained by [Javier Velasco](http

To work in the project you'd need a `node` version with ES6 syntax. Although the project is built using Babel we use some ES6 features in the development server. Also, the packages has been tested with `node 4.2.1`. Consider using [nvm](https://github.com/creationix/nvm) or [n](https://github.com/tj/n) to handle different node versions!

To start documentation site locally:

```
git clone https://github.com/react-toolbox/react-toolbox.git
cd docs/
npm install
npm start
```

Local documentation will be available at http://localhost:8081/

## License
This project is licensed under the terms of the [MIT license](https://github.com/react-toolbox/react-toolbox/blob/master/LICENSE).

0 comments on commit e476893

Please sign in to comment.