add a readme

Signed-off-by: Robert Günzler <r@gnzler.io>

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1008a70
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# svtree
+
+a frontend for s6-rc, with support for service templating, that you can run as
+a user service manager, but that also works for system services.
+
+## svtree-run
+
+spawns the s6-svscan process that is the root of the supervision tree, calls
+s6-rc-init and requests the `default` bundle to run
+
+## svtree-compile
+
+reloads the service definitions and swaps the active supervision tree
+
+## svtree-generate
+
+generates service definitions from templates
+
+## $XDG_CONFIG_HOME/s6-rc/src
+
+this is the base s6-rc service tree that is merged with the services generated
+by `s6-rc-generate`.
+There MUST at least be a default target, most commonly a `bundle` that declares
+the set of services that should run on boot.
+
+## $XDG_CONFIG_HOME/s6-rc/templates
+
+defines a set of services templates `s6-rc-generate` uses as input,
+the string `+service` will be replaced with the target service name
+(works in file names and inside files)
+
+## $XDG_CONFIG_HOME/s6-rc/generate
+
+defines a set of services `s6-rc-generate` should generate,
+the names MUST be in the format <template>.<service>