vitalif
/
react-toolbox
1
0
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity

Merge pull request #108 from liesislukas/master 

Readme update. Short instructions how to start docs locally
old
Javi Velasco 2015-11-15 17:33:59 +01:00
parent 5b9472c827 e476893aa3
commit e9eb429905
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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).