|author||brian m. carlson <firstname.lastname@example.org>||2017-12-10 23:55:38 +0000|
|committer||brian m. carlson <email@example.com>||2017-12-10 23:55:38 +0000|
README: document configuration
Signed-off-by: brian m. carlson <firstname.lastname@example.org>
1 files changed, 17 insertions, 1 deletions
diff --git a/README.adoc b/README.adoc
index 83eb3f1..254f409 100644
@@ -1,7 +1,23 @@
-This is a tool to generate daily feeds automatically.
+This is a tool to generate daily feeds automatically. It's designed for
+handling web comics, but it can handle any daily feed.
+Configuration is handled by creating a `config.json` file in the main directory.
+An example configuration file can be found in the `doc/example` directory.
+The `link` field for a comic can accept any pattern which works with
+`strftime(3)`. The `time` field expresses a time in GMT.
+You will generally want to change the `id` field in the `config` section to the
+URL of your installation. This allows the feeds to generate unique IDs that
+won't conflict with other installations.
+Due to the power of Ruby's in-order hash handling, comics should be listed in
+the same order as they're listed in the configuration file.