From b5ed21755dc396bab0e176b28b3b2a92715e1b8c Mon Sep 17 00:00:00 2001 From: Nicolas Dextraze Date: Wed, 9 Mar 2016 15:37:08 -0800 Subject: [PATCH] Updated readme.md --- README.md | 31 +++++++++++++++--------- src/{main.js => eventStoreConnection.js} | 0 2 files changed, 19 insertions(+), 12 deletions(-) rename src/{main.js => eventStoreConnection.js} (100%) diff --git a/README.md b/README.md index 5480ebb..e699b7e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ # eventstore-node A port of the EventStore .Net ClientAPI to Node.js -# Porting .Net Task to Node.js +## 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 - }); + connection + .appendToStream('myStream', client.expectedVersion.any, events, userCredentials) + .then(function(result) { + //Do something with the WriteResult here + }) + .catch(function(err) { + //Handle error here + }); -# Status +## Status + +Unstable Incomplete/missing features: @@ -24,9 +26,9 @@ Incomplete/missing features: - Set system settings: not implemented yet - 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 -- NPM package: no package released yet, I will release one when code is production ready +- NPM package: no package released yet, I will release one when code is stable -# Running the tests +## Running the tests You will need: - dependencies (npm install) @@ -36,3 +38,8 @@ You will need: To execute the tests suites simply run test with npm npm test + +## 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 https://github.com/nicdex/eventstore-node/blob/master/LICENSE diff --git a/src/main.js b/src/eventStoreConnection.js similarity index 100% rename from src/main.js rename to src/eventStoreConnection.js