[docs] Updated README, added example usage

2 files changed, 24 insertions, 9 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f47c67c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Couchdb Puppet module
+
+This module is based on the one from Camptocamp_.
+
+.. _Camptocamp: http://www.camptocamp.com/
+
+For more information about couchdb see http://couchdb.apache.org/
+
+# Dependencies
+
+- ruby module from the shared-modules group
+
+## Example usage
+
+This will setup couchdb:
+
+    # needed for wget call, which is unqualified by purpose so we don't force
+    # a location for the wget binary
+    Exec { path    => '/usr/bin:/usr/sbin/:/bin:/sbin:/usr/local/bin:/usr/local/sbin' }
+
+    class { 'couchdb':
+      admin_pw => '123'
+    }
+
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 2158f4d..0000000
--- a/README.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-=======================
-Couchdb Puppet module
-=======================
-
-This module is provided to you by Camptocamp_.
-
-.. _Camptocamp: http://www.camptocamp.com/
-
-For more information about couchdb see http://couchdb.apache.org/