Permalink
Browse files

Updated README

  • Loading branch information...
1 parent c57f58d commit bc05fa1d47a3eb37d002959e26d8d006a921c4f6 @chriso chriso committed Nov 16, 2010
Showing with 23 additions and 1 deletion.
  1. +23 −1 README.md
View
24 README.md
@@ -1,11 +1,33 @@
# [node.io](http://node.io/)
-A distributed data scraping and processing engine for [Node.JS](http://nodejs.org/), inspired by [Google's MapReduce](http://labs.google.com/papers/mapreduce.html).
+A distributed data scraping and processing engine for [Node.JS](http://nodejs.org/)
To install node.io, use [npm](http://github.com/isaacs/npm):
$ npm install node.io
+
+Run `$ node.io --help` for usage details
## Why node.io?
+- Seamlessly distribute work across child processes and servers (soon)
+- Handles a variety of input / output situations
+ * Reading / writing lines to and from files
+ * To / from a database
+ * STDIN / STDOUT
+ * Piping between node.io jobs
+ * Any combination of the above
+- Includes a robust framework for scraping and selecting HTML data
+- Support for proxied requests
+- Provides support for retries and timeouts
+
+## Examples
+
+See ./examples
+
+## Documentation
+
+Coming soon. See [http://node.io/](http://node.io/) for updates
+
+
*This is a _major_ work in progess.. check back soon!*

0 comments on commit bc05fa1

Please sign in to comment.