summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKen Barber <ken@bob.sh>2011-05-05 11:00:05 +0200
committerKen Barber <ken@bob.sh>2011-05-05 11:00:05 +0200
commitf71c3bd9e7b8826f331ae58d1a4de6acaad30883 (patch)
tree3c24b91d3099ab47de3296856aa34ee4107e104b
parentaafce9c99b779855e1e10e5a337848fa9f676a01 (diff)
Added disclaimer and basic installation guide to README.markdown file.
-rw-r--r--README.markdown18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown
index 66ff373..71a0e6e 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,3 +1,19 @@
## puppet-functions module
-This is the puppet-functions module. It provides a library of various functions that extend the basic function library that is provided in Puppet.
+### Overview
+
+This is the puppet-functions module. Here we are providing a library of various functions that extend the basic function library that is provided in Puppet.
+
+### Disclaimer
+
+Warning! While this software is written in the best interest of quality it has not been formally tested by our QA teams. Use at your own risk, but feel free to enjoy and perhaps improve it while you do.
+
+Please see the included Apache Software License for more legal details regarding warranty.
+
+### Installation
+
+From github, download the module into your modulepath on your Puppetmaster. If you are not sure where your module path is try this command:
+
+ puppet --configprint modulepath
+
+Depending on the version of Puppet, you may need to restart the puppetmasterd (or Apache) process before the functions will work.