]> gitweb.fluxo.info Git - puppet-stdlib.git/commitdiff
Added disclaimer and basic installation guide to README.markdown file.
authorKen Barber <ken@bob.sh>
Thu, 5 May 2011 09:00:05 +0000 (11:00 +0200)
committerKen Barber <ken@bob.sh>
Thu, 5 May 2011 09:00:05 +0000 (11:00 +0200)
README.markdown

index 66ff37324296e81c716dfaa489b2ad5af2a4eb63..71a0e6ea7acfc89ddb21da6eb100dbd85f65a4b1 100644 (file)
@@ -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.