Skip to content

Commit 3d32430

Browse files
authored
Update README.md
1 parent 4fd0f23 commit 3d32430

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
1-
# save-to-existing-directory
2-
Plugin for website-scraper which allows to save resources to existing directory
1+
[![Version](https://img.shields.io/npm/v/website-scraper-existing-directory.svg?style=flat)](https://www.npmjs.org/package/website-scraper-existing-directory)
2+
[![Downloads](https://img.shields.io/npm/dm/website-scraper-existing-directory.svg?style=flat)](https://www.npmjs.org/package/website-scraper-existing-directory)
3+
[![Build Status](https://travis-ci.org/website-scraper/website-scraper-existing-directory.svg?branch=master)](https://travis-ci.org/website-scraper/website-scraper-existing-directory)
4+
5+
# website-scraper-existing-directory
6+
Plugin for [website-scraper](https://github.com/s0ph1e/node-website-scraper) which allows to save resources to existing directory.
7+
8+
Please keep in mind that saving to existing directory may overwrite your files. Be careful with it!
9+
10+
## Requirements
11+
* nodejs version >= 8
12+
* website-scraper version >= 4
13+
14+
## Installation
15+
```sh
16+
npm install website-scraper website-scraper-existing-directory
17+
```
18+
19+
## Usage
20+
```javascript
21+
const scrape = require('website-scraper');
22+
const SaveToExistingDirectoryPlugin = require('website-scraper-existing-directory');
23+
24+
scrape({
25+
urls: ['http://example.com'],
26+
directory: '/path/to/save',
27+
plugins: [ new SaveToExistingDirectoryPlugin() ]
28+
});
29+
```

0 commit comments

Comments
 (0)