add readme

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

22
README.md Normal file
View File

@ -0,0 +1,22 @@
Scraper
=======
This project is a basic tool to scrap a data from a website
using a CSS selector.
For example, you are able to retrieve the number of a project's releases hosted on github:
```
node src/index.js \
--url https://github.com/foo/bar \
--selector '.repository-content .numbers-summary li:nth-child(4) a' \
--tags \
--breaks \
--spaces \
--breaks \
--trim
```
...will show `XXX releases`.
More help with `node src/index.js --help`.