Update Documentation and Purge Extras

Commit message from laurenrother
Before alterations, this content was the module author-determined
description of and instructions for use of the module.

As part of a joint Forge/Docs team effort to standardize formatting and
encourage quality module documentation, a best practices README
template was created via internal and external user testing. That
template was then applied to this module.

I pulled in content from the original README on GitHub as well as the
Forge Module Description. Standard headings were added (Overview,
Module Description, Setup, Usage,
Implementation, etc.) to organize content, existent content was moved
under its appropriate heading and edited for tone/flow/clarity, and
basic formatting was done to
adhere to template standards.

Extraneous, empty READMEs were deleted.

4 files changed, 0 insertions, 67 deletions

diff --git a/lib/puppet/facter/README.markdown b/lib/puppet/facter/README.markdown
deleted file mode 100644
index 2b96273..0000000
--- a/lib/puppet/facter/README.markdown
+++ /dev/null
@@ -1,22 +0,0 @@
-Facter
-======
-
-Define facts in this directory.
-
-Sometimes you need to be able to write conditional expressions based
-on site-specific data that just isn’t available via Facter. The
-solution may be to add a fact to Facter. These additional facts can
-then be distributed to Puppet clients and are available for use in
-manifests. Learn more at
-http://projects.puppetlabs.com/projects/puppet/wiki/Adding_Facts
-
-File paths should match the fact name; for example, a fact
-`hardware_platform`, defined like this:
-
-    Facter.add("hardware_platform") do
-        setcode do
-            %x{/bin/uname -i}.chomp
-        end
-    end
-
-Should be found in `hardware_platform.rb` in this directory.
diff --git a/lib/puppet/parser/functions/README.markdown b/lib/puppet/parser/functions/README.markdown
deleted file mode 100644
index 15d7495..0000000
--- a/lib/puppet/parser/functions/README.markdown
+++ /dev/null
@@ -1,17 +0,0 @@
-Functions
-=========
-
-Define functions in this directory.
-
-File paths should match the function name; for example, a function
-`myfunction`, defined like this:
-
-    Puppet::Parser::Functions::newfunction(
-        :myfunction,
-        :type => :statement,
-        :doc => "Documentation here."
-    ) do |vals|
-        # ...
-    end
-
-Should be found in `myfunction.rb` in this directory.
diff --git a/lib/puppet/provider/README.markdown b/lib/puppet/provider/README.markdown
deleted file mode 100644
index 27aa1a9..0000000
--- a/lib/puppet/provider/README.markdown
+++ /dev/null
@@ -1,14 +0,0 @@
-Providers
-=========
-
-Define providers under this directory.
-
-File paths should match the resource type name and provider name; for
-example, a provider `myprovider` for a resource type `mytype`, defined like this:
-
-    Puppet::Type.type(:mytype).provide(:myprovider) do
-        desc "Documentation here"
-        # ...
-    end
-
-Should be found in `mytype/myprovider.rb` under this directory.
diff --git a/lib/puppet/type/README.markdown b/lib/puppet/type/README.markdown
deleted file mode 100644
index 7a169c7..0000000
--- a/lib/puppet/type/README.markdown
+++ /dev/null
@@ -1,14 +0,0 @@
-Resource Types
-==============
-
-Define resource types in this directory.
-
-Filenames should match the resource type name; for example, a resource
-type `mytype`, defined like this:
-
-    Puppet::Type.newtype(:mytype) do
-        @doc = "Documentation here."
-        # ...
-    end
-
-Should be found in `mytype.rb`