@@ 24,3 24,27 @@ pip install -e .
Now running `wkrel help` command should produce a list of available
subcommands.
+
+
+Configuration
+-------------
+
+The tool is configured using a set of [YAML](https://yaml.org/) text files
+placed in a “configuration directory” — which can be passed to any command
+which accepts the `--config-dir`/`-C` command line option:
+
+- Each `.yml` file contains the configuration for a “release package” tarball.
+- A file named `defauls.yml` contains default configuration values which are
+ used for those values not overriden or specified in a release package
+ tarball.
+
+For the sake of convenience, when a configuration directory not indicated,
+the `conf/` subdirectory of the source distribution is used by default.
+
+Additionally, a `wkrel/user.yml` file can be used to specify configuration
+values which override those loaded from the configuration directory. This
+allows each person using the tool to easily indicate certain preferences like
+their e-mail address or PGP key used for signing packages. This user
+configuration file will be searched using the [XDG Base Directory
+Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html),
+which most of the time means it will be located at `~/.config/wkrel/user.yml`.