added a simple readme

1 files changed, 27 insertions, 0 deletions

diff --git a/README.asciidoc b/README.asciidoc
new file mode 100644
index 0000000..3dd0418
--- /dev/null
+++ b/README.asciidoc
@@ -0,0 +1,27 @@
+README
+======
+Markus Strauss <markus@itstrauss.eu>
+v0.1, 2011-10-27
+
+This is a very basic module to manage the http://smarden.org/runit/[runit] service supervisor.
+
+Example Usage
+^^^^^^^^^^^^^
+
+[source,txt]
+---------------------------------------------------------------------
+class { 'runit': }
+
+# define a environment variable, placed under /etc/sv/diaspora_worker/env/QUEUE
+runit::env { 'QUEUE': service => 'diaspora_worker' }
+
+# define a service unter /etc/sv/diaspora_worker
+runit::service { "diaspora_worker":
+  user    => diaspora,                        # service user and group
+  group   => diaspora,
+  rundir  => '/var/rails/diaspora',           # service run directory
+  command => 'bundle exec rake resque:work',  # command to start the service
+  enable  => true,                            # enabling the service by
+                                              # linking it to /etc/services/
+}
+---------------------------------------------------------------------