Permalink
Browse files

Improve readme.

  • Loading branch information...
1 parent 5e547d1 commit f4d8fd925cfade786698b58d5ab97b975940fb8a @Gozala committed Jun 29, 2011
Showing with 22 additions and 2 deletions.
  1. +22 −2 Readme.md
View
@@ -1,8 +1,28 @@
# fs #
-NodeJS filesystem API
+NodeJS filesystem API for Jetpack.
## Install ##
- npm install fs
+To use this package you will need [npm][http://npmjs.org/] and [graphquire].
+ git clone git://github.com/Gozala/jetpack-io.git
+ cd jetpack-io
+ npm install graphquire -g
+ npm link
+
+## Use ##
+
+You can use this package with a help of [graphquire]. To do so just use one of
+the following requires in your module:
+
+ require('https://raw.github.com/Gozala/jetpack-io/v0.1.0/fs.js')
+ require('https://raw.github.com/Gozala/jetpack-io/v0.1.0/net.js')
+ require('https://raw.github.com/Gozala/jetpack-io/v0.1.0/stream.js')
+
+And make sure to run `npm link` in your project before running.
+
+Alternatively you can install package as described in a previous section and
+use this it as a dependency.
+
+[graphquire]:https://github.com/Gozala/graphquire/

0 comments on commit f4d8fd9

Please sign in to comment.