forked from bndr/node-read
-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
43 lines (43 loc) · 2.5 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
"name": "node-reading-it",
"version": "1.0.0",
"author": {
"name": "madma001"
},
"description": "HTML scraper. Updated fork of https://github.com/bndr/node-read.",
"homepage": "https://github.com/madma/node-reading",
"dependencies": {
"cheerio": "^1.0.0-rc.2",
"fetch": "*"
},
"devDependencies": {
"mocha": "*",
"should": "*",
"nock": "~9.6.1"
},
"licenses": [
{
"type": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
],
"keywords": [
"readability",
"readable",
"scraper",
"extract"
],
"repository": {
"type": "git",
"url": "git://github.com/madma/node-reading"
},
"scripts": {
"test": "make test"
},
"main": "index.js",
"readme": "# Updated fork of Node-read. Original README follows.\n\nNode-read\n\nGet Readable Content from any page. Based on Arc90's readability project.\n\n## Features\n\n1. Blazingly Fast. This project is based on Cheerio engine, which is 8x times faster than JSDOM.\n\n## Why not Node-readability\n\nBefore starting this project I used Node-readability, but the dependencies of that project plus the slowness of JSDOM made it very frustrating to work with. The compiling of contextify module (dependency of JSDOM) failed 9/10 times. And if you wanted to use node-readability with node-webkit you had to manually rebuild contextify with nw-gyp, which is not the optimal solution.\n\nSo I decided to write my own version of Arc90's Readability using the fast Cheerio engine with the least number of dependencies.\n\nThe Usage of this module is similiar to node-readability, so it's easy to switch.\n\n## Install\n\n npm install node-read\n \n## Usage\n\n`read(html [, options], callback)`\n\nWhere\n\n * **html** url or html code.\n * **options** is an optional options object\n * **callback** is the callback to run - `callback(error, article, meta)`\n\nExample\n\n var read = require('node-read');\n\n read('http://howtonode.org/really-simple-file-uploads', function(err, article, res) {\n \n // Main Article.\n console.log(article.content);\n \n // Title\n console.log(article.title);\n\n // HTML \n console.log(article.html);\n \n // DOM\n console.log(article.dom);\n \n });\n",
"readmeFilename": "README.md",
"bugs": {
"url": "https://github.com/madma/node-reading/issues"
}
}