summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2017-12-10 23:55:38 +0000
committerbrian m. carlson <sandals@crustytoothpaste.net>2017-12-10 23:55:38 +0000
commite4a169b2878cd9960e143e6d2d9484b7b4426602 (patch)
tree930c7714b63184deb4bf475a22aa307d147d7964
parent016c9e068e82356b6a8859112582986bb2d0999b (diff)
README: document configuration
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
-rw-r--r--README.adoc18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.adoc b/README.adoc
index 83eb3f1..254f409 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,7 +1,23 @@
Generation Comics
=================
-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
+
+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.
== FAQ