Permalink
Browse files

clarify readme

  • Loading branch information...
dominictarr committed Mar 14, 2013
1 parent 6fc01f6 commit ac1b178f9fab94c5aa6c522c4fc0b214f2d581a6
Showing with 4 additions and 0 deletions.
  1. +4 −0 readme.markdown
View
@@ -12,6 +12,10 @@ on the server, it keeps the files in prefixed subdirectories, so that the direct
###create an instance
+`kv(path/prefix/connectString, setup)`
+
+`path` is where to create/connect to the store.
+
`setup` is optional. `setup` is passed the stream created by `put` and `get`, may replace the stream passed to put/get
by default, the stream is handled as newline seperated json.

0 comments on commit ac1b178

Please sign in to comment.