Permalink
Browse files

Fill out readme

  • Loading branch information...
1 parent 65c8297 commit 3177e2f357c72e8a10fd638d29587c66dcfd55f7 @nathanoehlman committed Nov 1, 2012
Showing with 28 additions and 3 deletions.
  1. +28 −3 README.md
View
@@ -1,4 +1,29 @@
-mockstream
-==========
+# mockstream
-Mockstream is a very simple utility library for testing streams.
+Mockstream is a very simple utility library of streams helpful for testing
+
+## Installing
+
+```npm install mockstream```
+
+## Streams
+
+### MockDataStream
+
+A simple readable stream that outputs a stream of a given length filled with bogus data (lots of 0's).
+
+#### Usage
+
+```
+var mockstream = require('mockstream'),
+ stream = new mockstream.MockDataStream({
+ chunkSize: 1024, // 1 KB data chunks
+ streamLength: 1048576 // 1 MB of data
+ });
+
+// Register listeners, etc
+
+// Start pumping data
+stream.start();
+
+```

0 comments on commit 3177e2f

Please sign in to comment.