From 5b3699f1aa5200202109a6ff59bd19a653762ee9 Mon Sep 17 00:00:00 2001 From: varac Date: Mon, 12 Oct 2015 14:14:25 +0200 Subject: [docs] Updated README, added example usage --- README.md | 24 ++++++++++++++++++++++++ README.rst | 9 --------- 2 files changed, 24 insertions(+), 9 deletions(-) create mode 100644 README.md delete mode 100644 README.rst 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/ -- cgit v1.2.3