Skip to content

Commit b91505f

Browse files
committed
Update README.md
1 parent f72cb45 commit b91505f

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
## Introduction
2-
Node.js module for website's scraping with images, css, js, etc.
2+
Download website to a local directory (including all css, images, js, etc.)
33

44
[![Build Status](https://img.shields.io/travis/s0ph1e/node-website-scraper/master.svg?style=flat)](https://travis-ci.org/s0ph1e/node-website-scraper)
5+
[![Test Coverage](https://codeclimate.com/github/s0ph1e/node-website-scraper/badges/coverage.svg)](https://codeclimate.com/github/s0ph1e/node-website-scraper/coverage)
56
[![Code Climate](https://codeclimate.com/github/s0ph1e/node-website-scraper/badges/gpa.svg)](https://codeclimate.com/github/s0ph1e/node-website-scraper)
67
[![Version](https://img.shields.io/npm/v/website-scraper.svg?style=flat)](https://www.npmjs.org/package/website-scraper)
78
[![Downloads](https://img.shields.io/npm/dm/website-scraper.svg?style=flat)](https://www.npmjs.org/package/website-scraper)
@@ -10,7 +11,9 @@ Node.js module for website's scraping with images, css, js, etc.
1011
[![NPM Stats](https://nodei.co/npm/website-scraper.png?downloadRank=true&stars=true)](https://www.npmjs.org/package/website-scraper)
1112

1213
## Installation
13-
`npm install website-scraper`
14+
```
15+
npm install website-scraper
16+
```
1417

1518
## Usage
1619
```javascript
@@ -33,25 +36,24 @@ scraper.scrape(options).then(function (result) {
3336

3437
## API
3538
### scrape(options, callback)
36-
Makes request to `url` and saves all files found with `sources` to `directory`.
39+
Makes requests to `urls` and saves all files found with `sources` to `directory`.
3740

3841
**options** - object containing next options:
3942

4043
- `urls:` array of urls to load and filenames for them *(required, see example below)*
4144
- `directory:` path to save loaded files *(required)*
42-
- `log:` boolean indicates whether to write the log to console *(optional, default: false)*
4345
- `defaultFilename:` filename for index page *(optional, default: 'index.html')*
44-
- `sources:` array of objects to load, specifies selectors and attribute values to select files for loading *(optional, see default value in `lib/defaults.js`)*
46+
- `sources:` array of objects to load, specifies selectors and attribute values to select files for loading *(optional, see default value in `lib/config/defaults.js`)*
4547
- `subdirectories:` array of objects, specifies subdirectories for file extensions. If `null` all files will be saved to `directory` *(optional, see example below)*
4648
- `request`: object, custom options for [request](https://github.com/request/request#requestoptions-callback) *(optional, see example below)*
4749

4850

4951
**callback** - callback function *(optional)*, includes following parameters:
5052

51-
- `error:` if error - `Error object`, if success - `null`
53+
- `error:` if error - `Error` object, if success - `null`
5254
- `result:` if error - `null`, if success - array if objects containing:
5355
- `url:` url of loaded page
54-
- `filename:` absolute filename where page was saved
56+
- `filename:` filename where page was saved (relative to `directory`)
5557

5658

5759
## Examples
@@ -68,6 +70,7 @@ and separate files into directories:
6870
- `css` for .css (full path `/path/to/save/css`)
6971

7072
```javascript
73+
var scraper = require('website-scraper');
7174
scraper.scrape({
7275
urls: [
7376
'http://nodejs.org/', // Will be saved with default filename 'index.html'
@@ -92,13 +95,7 @@ scraper.scrape({
9295
}
9396
}).then(function (result) {
9497
console.log(result);
98+
}).catch(function(err){
99+
console.log(err);
95100
});
96101
```
97-
98-
## Dependencies
99-
100-
- cheerio
101-
- request
102-
- bluebird
103-
- fs-extra
104-
- underscore

0 commit comments

Comments
 (0)