sbrl-github
/
PolyFeed
mirror of https://github.com/sbrl/PolyFeed.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Add basic usage to README

This commit is contained in:
Starbeamrainbowlabs 2019-07-29 20:55:37 +01:00
parent d72f3256e9
commit 18ec61c80c
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -22,8 +22,15 @@ The build output will be outputted to `PolyFeed/bin/Release`.
## Usage
PolyFeed uses [TOML](https://github.com/toml-lang/toml) configuration files to define Atom feeds. First, create a configuration file that specifies how PolyFeed should generate an Atom feed - or use [one of the examples](https://github.com/sbrl/PolyFeed/tree/master/examples).
Then, run PolyFeed over it:
```bash
path/to/PolyFeed.exe --config path/to/config.toml
```
...it will generate the named `.atom` file automatically, keeping you up-to-date on it's progress and any errors it encounters.
## Contributing