Create README.md

Author: KlonD90

README.md

@@ -0,0 +1,94 @@
+# node-tarantool-driver
+Node tarantool driver for 1.6 support Node.js v.0.10+ and IO.js.
+
+Based on https://github.com/mialinx/go-tarantool-1.6 and implements http://tarantool.org/doc/dev_guide/box-protocol.html, for more information you can read them or basic documentation at http://tarantool.org/doc/.
+
+For work with tarantool tuple i use node-msgpack(https://github.com/pgriess/node-msgpack) and array default transformation with this package.
+
+If you have a problem with connection it will be destroyed. You can subscribe on TarantoolConnection.socket.on('close') for retrieve information about closing connection or you can process rejected errors for you requests.
+
+##Install
+
+```
+npm install --save tarantool-driver
+```
+
+##Usage example
+
+We use TarantoolConnection instance and connect before other operations. Methods call return promise(through vow(https://github.com/dfilatov/vow). Available methods with some testing: select, update, replace, insert, delete, auth, destroy.
+```
+var TarantoolConnection = require('tarantool-driver');
+var conn = new TarantoolConnection({port: 3301});
+conn.connect()
+.then(function(){
+  //auth for login, password
+  return conn.auth('test', 'test');
+}).then(function(){
+  // select arguments space_id, index_id, limit, offset, iterator, key
+  return conn.select(512, 0, 1, 0, 'eq', [50]);
+})
+.then(funtion(results){
+  doSomeThingWithResults(results);
+});
+```
+
+##API
+
+**class TarantoolConnection(options)**
+```
+var defaultOptions = {
+    host: 'localhost',
+    port: '3301'
+};
+```
+You can overrid default options with options.
+
+**connect() : Promise**
+
+Resolve if connected. Or reject if not.
+
+**auth(login: String, password: String) : Promise **
+
+Auth with using chap-sha1(http://tarantool.org/doc/book/box/box_space.html). About authenthication more here: http://tarantool.org/doc/book/box/authentication.html
+
+**select(spaceId: Number, indexId: Number, limit: Number, iterator: Iterator, key: tuple) : Promise( Array of tuples)**
+
+Iterators: http://tarantool.org/doc/book/box/box_index.html
+```
+const IteratorsType = {
+	eq: 0,
+	req: 1,
+	all: 2,
+	lt: 3,
+	le: 4,
+	ge: 5,
+	gt: 6,
+	bitsAllSet: 7,
+	bitsAnySet: 8,
+	bitsAllNotSet: 9
+};
+```
+It's just select. Promise resolve array of tuples.
+
+**delete(spaceId: Number, indexId: Number, key: tuple) : Promise(Array of tuples) **
+
+Promise resolve an array of deleted tuples.
+
+**update(spaceId: Number, indexId: Number, key: tuple, ops) : Promise(Array of tuples)**
+
+Ops: http://tarantool.org/doc/book/box/box_space.html(search for update here).
+
+Promise resolve an array of updated tuples.
+
+**insert(spaceId: Number, tuple: tuple) : Promise(Tuple) **
+
+So it's insert. More you can read here: http://tarantool.org/doc/book/box/box_space.html
+
+Promise resolve a new tuple.
+
+
+**replace(spaceId: Number, tuple: tuple) : Promise(Tuple) **
+
+So it's replace. More you can read here: http://tarantool.org/doc/book/box/box_space.html
+
+Promise resolve a new or replaced tuple.