Create README.md
This commit is contained in:
parent
81c1f00cbd
commit
bbc4709dd4
|
@ -0,0 +1,28 @@
|
|||
# EPG Grabber
|
||||
|
||||
Node.js CLI tool for grabbing EPG from different sites.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install -g epg-grabber
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
epg-grabber --config=example.com.config.js
|
||||
```
|
||||
|
||||
Arguments:
|
||||
|
||||
- `-c, --config`: path to config file
|
||||
- `-d, --debug`: enable debug mode
|
||||
|
||||
## Contribution
|
||||
|
||||
If you find a bug or want to contribute to the code or documentation, you can help by submitting an [issue](https://github.com/freearhey/epg-grabber/issues) or a [pull request](https://github.com/freearhey/epg-grabber/pulls).
|
||||
|
||||
## License
|
||||
|
||||
[MIT](http://opensource.org/licenses/MIT)
|
Loading…
Reference in New Issue