Updated README.md with dependencies

This commit is contained in:
Nicolas Dextraze 2016-03-09 17:08:03 -08:00
parent b65600f92c
commit 29f6bf210b

View File

@ -1,18 +1,11 @@
# eventstore-node # eventstore-node
A port of the EventStore .Net ClientAPI to Node.js A port of the EventStore .Net ClientAPI to Node.js
## Porting .Net Task to Node.js ## Dependencies
I used Promise to replace .Net Task, so when executing an async command, i.e. appendToStream you'll have to wait for result/error like this: - Node.js >= 0.12
- protobufjs module
connection - uuid module
.appendToStream('myStream', client.expectedVersion.any, events, userCredentials)
.then(function(result) {
//Do something with the WriteResult here
})
.catch(function(err) {
//Handle error here
});
## Status ## Status
@ -28,11 +21,24 @@ Incomplete/missing features:
- 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 - NPM package: no package released yet, I will release one when code is stable
## Porting .Net Task to Node.js
I used Promise to replace .Net Task, so when executing an async command, i.e. appendToStream you'll have to wait for result/error like this:
connection
.appendToStream('myStream', client.expectedVersion.any, events, userCredentials)
.then(function(result) {
//Do something with the WriteResult here
})
.catch(function(err) {
//Handle error here
});
## Running the tests ## Running the tests
You will need: You will need:
- dependencies (npm install) - dependencies (`npm install`)
- nodeunit (npm install -g nodeunit) - nodeunit (`npm install -g nodeunit`)
- an instance of EventStore running on localhost:1113 (https://geteventstore.com/downloads/) - an instance of EventStore running on localhost:1113 (https://geteventstore.com/downloads/)
To execute the tests suites simply run test with npm To execute the tests suites simply run test with npm