Update README per DOC-1503
authorPete Soloway <pete@puppetlabs.com>
Tue, 14 Apr 2015 01:35:10 +0000 (18:35 -0700)
committerPete Soloway <pete@puppetlabs.com>
Mon, 27 Apr 2015 17:27:58 +0000 (10:27 -0700)
commitccd5cea444a4f9762cd3f1cf1732eb4d03111f30
treea0074d6bb8e067cf364059bc399b8886e35b7676
parent80d83d9a88267737a8dbefb751322ce7bcc2b072
Update README per DOC-1503

1. Make sure that for each parameter, where applicable, there is a default value.
2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional.
3. Make sure the links in the README work and are accurate.
4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html
5. General copyediting.

* Add a ToC
* Reorganize Usage & Reference sections
* Standardize capitalization of "Apt" (as opposed to "apt", the module)
* Standardize Development section

Apply edits from @jbondpdx

* Re-emphasize the warning about short key names
* Restore the “What apt affects” section
* Re-correct capitalization of “Apt” (where it had reverted to “APT”)
* Clarify OS compatibility in Limitations and elsewhere
* Various edits for clarity
README.md