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

Update readme for NPM release

Browse Source
This commit is contained in:
Nicolas Dextraze
2016-03-16 23:15:25 -07:00
parent 77704a8786
commit ae1ddbe266
1 changed files with 20 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -4,8 +4,7 @@ A port of the EventStore .Net ClientAPI to Node.js
## Dependencies ## Dependencies
- Node.js >= 0.12 - Node.js >= 0.12
- protobufjs module - Modules: [long](https://www.npmjs.org/package/long), [protobufjs](https://www.npmjs.org/package/protobufjs), [uuid](https://www.npmjs.org/package/uuid) (installed via `npm install`)
- uuid module
## Status ## Status
@@ -22,7 +21,17 @@ Unstable
- Typed errors: currently most errors are direct instance of Error, which is not practical for error handling - Typed errors: currently most errors are direct instance of Error, which is not practical for error handling
- 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
- NPM package: no package released yet, I will release one when code is stable
## Getting started
Install the client using npm
npm install eventstore-node
Examples
TODO
## Porting .Net Task to Node.js ## Porting .Net Task to Node.js
@@ -38,11 +47,12 @@ I used Promise to replace .Net Task, so when executing an async command, i.e. ap
}); });
## Running the tests ## Running the tests
You will need:
- dependencies (`npm install`) To run the tests you will need
- nodeunit (`npm install -g nodeunit`)
- an instance of EventStore running on localhost:1113 (https://geteventstore.com/downloads/) - To install the dependencies (`npm install`)
- To install nodeunit (`npm install -g nodeunit`)
- Run an instance of EventStore >= 3.3.0 (competing consumers are required for test) on localhost:1113 (Download [here](https://geteventstore.com/downloads/))
To execute the tests suites simply run test with npm To execute the tests suites simply run test with npm
@@ -50,6 +60,6 @@ To execute the tests suites simply run test with npm
## License ## License
This is a port, original code is released under the EventStore license and can be found at https://github.com/eventstore/eventstore. Ported code is released under the MIT license, see [LICENSE](https://github.com/nicdex/eventstore-node/blob/master/LICENSE).
Ported code is released under the MIT license, see https://github.com/nicdex/eventstore-node/blob/master/LICENSE Original code is released under the EventStore license and can be found at https://github.com/eventstore/eventstore.