From 18ec61c80ce446512e1ab56b7c8d597b79b469a5 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Mon, 29 Jul 2019 20:55:37 +0100 Subject: [PATCH] Add basic usage to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 813c7e3..82dc733 100644 --- a/README.md +++ b/README.md @@ -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