add basic README info

Modulefile

@@ -5,6 +5,6 @@ author 'Joshua Hoblitt <jhoblitt@cpan.org>'
 license 'Apache'
 project_page 'https://github.com/jhoblitt/puppet-mdadm'
 source 'https://github.com/jhoblitt/puppet-mdadm.git'
-summary 'module skeleton'
-description 'module skeleton'
+summary 'Manages the `mdadm` util for Linux software RAID arrays'
+description 'Manages the `mdadm` util for Linux software RAID arrays'
 dependency 'puppetlabs/stdlib', '>= 3.0.0'

README.md

@@ -1,5 +1,5 @@
 Puppet mdadm Module
-=========================
+===================
 
 [![Build Status](https://travis-ci.org/jhoblitt/puppet-mdadm.png)](https://travis-ci.org/jhoblitt/puppet-mdadm)
 
@@ -18,20 +18,94 @@ Puppet mdadm Module
 Overview
 --------
 
+Manages the `mdadm` util for Linux software RAID arrays
+
 
 Description
 -----------
 
+This module installs the
+[`mdadm`](http://www.linuxfoundation.org/collaborate/workgroups/linux-raid)
+package for the management of Linux Software RAID arrays, and provides limited
+configuration support.  Specifically, this module does not presently provide
+any support for the creation, modification, or removal of `md` arrays.
+Management is limited to configuring monitoring of pre-existing `md` arrays,
+and array health checks.
+
 
 Usage
 -----
 
+### Example
+
+```puppet
+include ::mdadm
+
+```
+
+### Classes
+
+#### `mdadm`
+
+```puppet
+# defaults
+class { '::mdadm':
+  config_options     => {},
+  force_service      => false,
+  service_ensure     => 'running',
+  service_enable     => true,
+  raid_check_options => {},
+}
+```
+
+##### `config_options`
+
+`Hash`  defaults to '{}'
+
+##### `force_service`
+
+`Bool`  defaults to 'false'
+
+##### `service_ensure`
+
+`String`  defaults to 'running'
+
+Valid strings are: 'running', 'stopped'
+
+##### `service_enable`
+
+`Bool`  defaults to 'true'
+
+##### `raid_check_options`
+
+`Hash`  defaults to '{}'
+
+### Facts
+
+#### `mdadm`
+
+Path to the `mdadm` executable. Example:
+
+    /sbin/mdadm
+
+#### `mdadmversion`
+
+Version string of the `mdadm` executable. Example:
+
+    v3.2.3
+
+#### `mdadm_arrays`
+
+A listing of `/dev/<foo>` `md` devices. Example:
+
+    /dev/md0,/dev/md1
 
 Limitations
 -----------
 
 ### Tested Platforms
 
+* el6.x
 
 Versioning
 ----------
@@ -50,3 +124,6 @@ Please log tickets and issues at
 See Also
 --------
 
+* http://www.linuxfoundation.org/collaborate/workgroups/linux-raid
+* http://neil.brown.name/blog/mdadm
+* https://raid.wiki.kernel.org/index.php/RAID_setup