add documentation

This commit is contained in:
Simon Vieille 2020-04-11 22:35:30 +02:00
parent ac093e01d4
commit f3d9440994
Signed by: deblan
GPG Key ID: 03383D15A1D31745
1 changed files with 14 additions and 0 deletions

View File

@ -20,3 +20,17 @@ node src/index.js \
...will show `XXX releases`.
More help with `node src/index.js --help`.
Installation
------------
Requirements:
* node >= 10
* yarn
```
$ git clone https://gitnet.fr/deblan/scraper.git
$ cd scraper
$ yarn
```