From 7d662758face237ecafc8fd215f6ff63c75e016b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= <anarcat@koumbit.org>
Date: Sat, 22 Jun 2013 14:29:22 -0400
Subject: [PATCH] add a README explaining how to use this

---
 README.mdwn | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.mdwn

diff --git a/README.mdwn b/README.mdwn
new file mode 100644
index 0000000..9ec1155
--- /dev/null
+++ b/README.mdwn
@@ -0,0 +1,40 @@
+sudo support in puppet
+======================
+
+To simply install sudo on your servers, use:
+
+    include sudo
+
+By default, this will not deploy any sudoers file. Use the following
+to make sure a sudoers file is deployed:
+
+    class { 'sudo': deploy_sudoers => TRUE }
+
+This will deploy the default sudoers file shipped with the module or
+one shipped in your `site_sudo` module, see `manifests/init.pp` for
+the search path.
+
+You can also use defines to grant specific access. For example, to
+give access to a user:
+
+    sudo::access { 'foo': }
+
+This will create a file in `/etc/sudoers.d/01_user_access-foo` with a
+content:
+
+    foo ALL=(ALL) ALL
+
+You can change parameters, for example a no password access:
+
+    sudo::access { 'foo':
+        user => 'bar',
+        access => 'ALL = NOPASSWD: ALL'
+    }
+
+You can also create user aliases with:
+
+    sudo::user_alias { 'GROUP': members => 'foo, bar' }
+
+.. which in turn can be used in `sudo::access`:
+
+    sudo::access { 'GROUP-access': user => 'GROUP' }