Skip to content

Commit

Permalink
adding README
Browse files Browse the repository at this point in the history
  • Loading branch information
arrix committed Nov 19, 2010
1 parent c037eb8 commit 96fcb92
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
@@ -0,0 +1,30 @@
# node-readability
[Readability.js by Arc90](http://lab.arc90.com/experiments/readability/) ported to node.js.

Blog post: [Server side readability with node.js](http://arrix.blogspot.com/2010/11/server-side-readability-with-nodejs.html)
## Requirements
* [node.js](http://nodejs.org/)
* [jsdom](https://github.com/tmpvar/jsdom)
* [htmlparser](https://github.com/tautologistics/node-htmlparser)

## Live demo
I'm working on it...
## Example

var readability = require('readability');
//...
// This is an very early example. The API is subject to change.
readability.parse(html, url, function(result) {
console.log(result.title, result.content);
});

## Performance
In my testing of 70 pages with an average size of **58KB** collected from [digg](http://digg.com/news.rss), [delicious](http://feeds.delicious.com/v2/rss/?count=50) and [hacker news](http://news.ycombinator.com/rss), the average time taken for each page is about **1.3 seconds** on a Mac Mini (2.4G Intel Core 2 Duo).
## Limitation
* no fetching next pages
* no support for frames

## Plan
* Performance optimization
* Better API, more options
* Support more readability features

0 comments on commit 96fcb92

Please sign in to comment.