Permalink
Browse files

document new writable api

  • Loading branch information...
1 parent d0ed926 commit 97e596b291b522b011dfb05ed70b8532e9871e1a @substack committed May 11, 2012
Showing with 16 additions and 8 deletions.
  1. +13 −5 README.markdown
  2. +3 −3 package.json
View
@@ -15,12 +15,13 @@ methods
var cursory = require('cursory');
````
-var pos = cursory(stream, width)
---------------------------------
+var pos = cursory(width)
+------------------------
-Create a new cursor position `pos` from a stream and optionally a window width.
+Return a new writable stream `pos` from an optional window width.
-The `stream` should emit 'data' events with binary `Buffer` payloads.
+`pos` has attributes that update and events that fire as the screen position
+state of the input stream changes.
attributes
==========
@@ -46,4 +47,11 @@ Emitted when the cursor position updates.
install
=======
- npm install cursory
+```
+npm install cursory
+```
+
+license
+=======
+
+MIT
View
@@ -1,6 +1,6 @@
{
"name" : "cursory",
- "version" : "0.0.0",
+ "version" : "0.1.0",
"description" : "compute the relative cursor position on a terminal stream",
"main" : "index.js",
"directories" : {
@@ -9,7 +9,7 @@
"test" : "test"
},
"dependencies" : {
- "binary" : "0.2.5"
+ "binary" : "~0.2.6"
},
"devDependencies" : {
"tap" : "~0.2.4",
@@ -36,6 +36,6 @@
"email" : "mail@substack.net",
"url" : "http://substack.net"
},
- "license" : "MIT/X11",
+ "license" : "MIT",
"engine" : { "node" : ">=0.4" }
}

0 comments on commit 97e596b

Please sign in to comment.