Document yoyo.ini options in README

1 files changed, 49 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index 381a83f..fedd836 100755
--- a/README.rst
+++ b/README.rst
@@ -127,6 +127,55 @@ their single argument. For example::
 
     step(do_step)
 
+Configuration file
+------------------
+
+Yoyo looks for a configuration file named ``yoyo.ini`` in the current working
+directory or any ancestor directory. This can contain the following
+options::
+
+  [DEFAULT]
+
+  # List of migration source directories. "%(here)s" is expanded to the
+  # full path of the directory containing this ini file.
+  sources = %(here)s/migrations %(here)s/lib/module/migrations
+
+  # Target database
+  database = postgresql://scott:tiger@localhost/mydb
+
+  # Verbosity level. Goes from 0 (least verbose) to 3 (most verbose)
+  verbosity = 3
+
+  # Disable interactive features
+  batch_mode = on
+
+  # Editor to use when starting new migrations
+  # "{}" is expanded to the filename of the new migration
+  editor = /usr/local/bin/vim -f {}
+
+  # An arbitrary command to run after a migration has been created
+  # "{}" is expanded to the filename of the new migration
+  post_create_command = hg add {}
+
+
+Config file inheritance may be used to customize configuration per site::
+
+  #
+  # file: yoyo-defaults.ini
+  #
+  [DEFAULT]
+  sources = %(here)s/migrations
+
+
+  #
+  # file: yoyo.ini
+  #
+  [DEFAULT]
+  %inherit %(here)s/yoyo-defaults.ini
+  database = sqlite:///%(here)s/mydb.sqlite
+
+
+
 Transactions
 ------------