mirror of
https://github.com/sbrl/PolyFeed.git
synced 2024-11-21 06:22:59 +00:00
Add basic usage to README
This commit is contained in:
parent
d72f3256e9
commit
18ec61c80c
1 changed files with 7 additions and 0 deletions
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue