Permalink
Browse files

Updated README

  • Loading branch information...
1 parent 421e595 commit 32e830e81eb8e206bfc9e50d9aa5bc2c98a4a29d @chriso chriso committed Dec 21, 2010
Showing with 8 additions and 10 deletions.
  1. +8 −10 README.md
View
@@ -1,6 +1,6 @@
-[node.io](http://node.io/) is a distributed data scraping and processing framework
+**[node.io](http://node.io/) is a distributed data scraping and processing framework**
-- Jobs are written in Javascript or Coffeescript and run in Node.js - jobs are concise, asynchronous and _FAST_
+- Jobs are written in Javascript or [Coffeescript](http://jashkenas.github.com/coffee-script/) and run in [Node.JS](http://nodejs.org/) - jobs are concise, asynchronous and _FAST_
- Includes a robust framework for scraping, selecting and traversing data from the web
- Includes a data validation and sanitization framework
- Easily handle a variety of input / output - files, databases, streams, stdin/stdout, etc.
@@ -11,33 +11,31 @@ Follow [@nodeio](http://twitter.com/nodeio) for updates.
## Installation
-To install node.io, run
+To install node.io, use [npm](http://github.com/isaacs/npm)
$ npm install node.io
-If you do not have [Node.JS](http://nodejs.org/) or [npm](http://github.com/isaacs/npm) installed, [see this page](https://github.com/chriso/node.io/wiki/Installation).
+If you do not have npm or Node.JS v0.2.5+, [see this page](https://github.com/chriso/node.io/wiki/Installation).
## Getting started
-[Head over to the wiki for documentation, examples and the API](https://github.com/chriso/node.io/wiki)
+[Head over to the wiki for documentation, examples and the API](https://github.com/chriso/node.io/wiki).
## Roadmap
+[history.md](https://github.com/chriso/node.io/blob/master/HISTORY.md) lists recent changes.
+
- More tests & better coverage
- Finish writing up the wiki
- Fix up the [http://node.io/](http://node.io/) page
- Add more DOM [selector](http://api.jquery.com/category/selectors/) / [traversal](http://api.jquery.com/category/traversing/) methods
- Add distributed processing
- Speed improvements
-[history.md](https://github.com/chriso/node.io/blob/master/HISTORY.md) lists recent changes.
-
-## Contributing
+If you want to contribute, please [fork/pull](https://github.com/chriso/node.io/fork).
If you find a bug, please report the issue [here](https://github.com/chriso/node.io/issues).
-If you want to contribute, please [fork/pull](https://github.com/chriso/node.io/fork).
-
## Credits
node.io wouldn't be possible without

0 comments on commit 32e830e

Please sign in to comment.