# readability

> Arc90's readability.js adapted to node.js

Latest version **0.1.0** (published 2015-01-01) · 0 weekly downloads

## Install

```sh
npm install readability
pnpm add readability
yarn add readability
bun add readability
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-01-01 |
| First published | 2015-01-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.3.1 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | Arrix |
| Keywords | readability |

## Links

- npm: https://www.npmjs.com/package/readability
- Issues: http://github.com/arrix/node-readability/issues
- npm.io page: https://npm.io/package/readability

## Dependencies (3)

- [jsdom](https://npm.io/package/jsdom.md) >=0.1.21
- [htmlparser](https://npm.io/package/htmlparser.md) >=1.7.2
- [mjsunit.runner](https://npm.io/package/mjsunit.runner.md) >=0.1.0

## Recent versions

- 0.1.0 (latest) — 2015-01-01

## README

# 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 140 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.1 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

---
_Source: https://npm.io/package/readability · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._