nicdex/node-eventstore-client
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add Documentation section to README

Browse Source
This commit is contained in:
Nicolas Dextraze 2016-11-07 22:09:57 -08:00
parent 99d9322d2a
commit 269c89be29
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -22,6 +22,16 @@ Unstable
- Performance: there's still some while loop in the code that could be problematic with node.js - Performance: there's still some while loop in the code that could be problematic with node.js
- Tests: tests are only covering happy path scenarios for now - Tests: tests are only covering happy path scenarios for now
### Documentation
#### Offline
The offline documentation can be found in the module folder `./node_modules/eventstore-node/docs`.
#### Online
The online documentation can be found at [https://dev.nicdex.com/eventstore-node/docs/](https://dev.nicdex.com/eventstore-node/docs/)
## Getting started ## Getting started
### Install & run Eventstore on localhost ### Install & run Eventstore on localhost