Permalink
Browse files

Added readme.txt

  • Loading branch information...
1 parent 290966b commit 784b89176c6b30b6af4dd51c6d7d097de9837e24 @waveto committed Jul 6, 2009
Showing with 30 additions and 0 deletions.
  1. +30 −0 readme.txt
View
@@ -0,0 +1,30 @@
+node-tyrant
+===========
+
+Version : 0.1
+rhys@wave.to 6th July 2009
+
+This is an implementation of the Tokyo Tyrant network protocol for the Node javascript/v8 language.
+
+
+Pre-requisits
+Install Tokyo Cabinet / Tokyo Tyrant, and set up either a b-tree or table database:
+
+For a table database:
+ttserver casket.tdb
+
+For a b-tree (key/value) database:
+ttserver casket.tcb
+
+
+Quick Example
+
+var tyrant = require("tyrant.js");
+tyrant.put('town', 'Bangor');
+
+tyrant.get('town', function(value, error) {
+ puts('Result '+i+' : '+value);
+});
+
+
+

0 comments on commit 784b891

Please sign in to comment.