Rewrite the README and prepare the CHANGELOG.

Author: Ashley Penney

CHANGELOG

@@ -1,3 +1,7 @@
+2013-07-08 - Version 1.0.0
+Features:
+- Completely refactored to split across several classes.
+
 2011-11-10 Dan Bode <[email protected]> - 0.0.4
 Add Amazon Linux as a supported platform
 Add unit tests

README.markdown

@@ -1,110 +1,173 @@
-ntp
-====
+#ntp
 
-[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-ntp.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-ntp)
+####Table of Contents
 
+1. [Overview](#overview)
+2. [Module Description - What the module does and why it is useful](#module-description)
+3. [Setup - The basics of getting started with ntp](#setup)
+    * [What ntp affects](#what-ntp-affects)
+    * [Setup requirements](#setup-requirements)
+    * [Beginning with ntp](#beginning-with-ntp)
+4. [Usage - Configuration options and additional functionality](#usage)
+5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+5. [Limitations - OS compatibility, etc.](#limitations)
+6. [Development - Guide for contributing to the module](#development)
 
-Overview
---------
+##Overview
 
-The NTP module installs, configures, and manages the network time service.
+The NTP module installs, configures, and manages the ntp service.
 
+##Module Description
 
-Module Description
--------------------
+The NTP module handles running NTP across a range of operating systems and
+distributions.  Where possible we use the upstream ntp templates so that the
+results closely match what you'd get if you modified the package default conf
+files.
 
-The NTP module allows Puppet to install, configure, and then manage your Network Time Protocol service. The module allows you to setup and manage time settings across many servers from one place. 
+##Setup
 
-Setup
------
+###What ntp affects
 
-**What NTP affects:**
+* ntp package.
+* ntp configuration file.
+* ntp service.
 
-* package/service/configuration files for NTP
-* server settings
-	
-### Beginning with NTP	
+###Beginning with ntp
 
-To setup NTP on a server
+include '::ntp' is enough to get you up and running.  If you wish to pass in
+parameters like which servers to use then you can use:
 
-    class { "ntp":
-      servers    => [ 'time.apple.com' ],
-      autoupdate => false,
+    class { '::ntp':
+      servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
     }
 
-Usage
-------
+##Usage
 
-When making changes to your configuration of NTP, you may need to stop and restart the ntp service. To keep the ntp service stopped, pass ensure => stopped to the class:
+All interaction with the ntp module can do be done through the main ntp class.
+This means you can simply toggle the options in the ntp class to get at the
+full functionality.
 
-    class { ntp:
-      ensure     => running,
-      servers    => [ 'time.apple.com iburst',
-                      'pool.ntp.org iburst' , ]
-      autoupdate => true,
+###I just want NTP, what's the minimum I need?
+
+    include '::ntp'
+
+###I just want to tweak the servers, nothing else.
+
+    class { '::ntp':
+      servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
     }
 
-The `ntp` class has several parameters to assist configuration of the ntp service.
 
-**Parameters within `ntp`**
+###I'd like to make sure I restrict who can connect as well.
 
-####`servers`
+    class { '::ntp':
+      servers  => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
+      restrict => 'restrict 127.0.0.1',
+    }
 
-NTP will use your operating system's default server if this parameter is left unspecified. This parameter accepts an array of servers,
-    
-    class { 'ntp':
-      servers => [ '0.debian.pool.ntp.org iburst',
-                   '1.debian.pool.ntp.org iburst',
-                   '2.debian.pool.ntp.org iburst',
-                   '3.debian.pool.ntp.org iburst', ]
+###I'd like to opt out of having the service controlled, we use another tool for that.
+
+    class { '::ntp':
+      servers        => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
+      restrict       => 'restrict 127.0.0.1',
+      manage_service => false,
     }
 
-####`restrict`
+###Looks great!  But I'd like a different template, we need to do something unique here.
+
+    class { '::ntp':
+      servers         => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
+      restrict        => 'restrict 127.0.0.1',
+      manage_service  => false,
+      config_template => 'different/module/custom.template.erb',
+    }
 
-This parameter specifies whether to restrict ntp daemons from allowing others to use as a server.
+##Reference
+
+###Classes
+
+* ntp: Main class, includes all the rest.
+* ntp::install: Handles the packages.
+* ntp::config: Handles the configuration file.
+* ntp::service: Handles the service.
+
+###Parameters
+
+The following parameters are available in the ntp module
 
 ####`autoupdate`
 
-This parameter is used to determine whether the ntp package will be updated automatically or not.
+Deprecated: This parameter previously determined if the ntp module should be
+automatically updated to the latest version available.  Replaced by package\_
+ensure.
+
+####`config`
+
+This sets the file to write ntp configuration into.
+
+####`config_template`
+
+This determines which template puppet should use for the ntp configuration.
 
-####`enable` 
+####`package_ensure`
 
-This parameter allows you to choose whether to automatically start ntp daemon on boot.
+This can be set to 'present' or 'latest' or a specific version to choose the
+ntp package to be installed.
 
-####`template`
+####`package_name`
 
-This parameter allows you to explicitly override the template used.
+This determines the name of the package to install.
 
+####`restrict`
+
+This sets the restrict options in the ntp configuration.
+
+####`servers`
+
+This selects the servers to use for ntp peers.
+
+####`service_enable`
+
+This determines if the service should be enabled at boot.
+
+####`service_ensure`
+
+This determines if the service should be running or not.
 
-Limitations
-------------
+####`service_manage`
 
-This module has been built and tested using Puppet 2.6.x, 2.7, and 3.x.
+This selects if puppet should manage the service in the first place.
+
+####`service_name`
+
+This selects the name of the ntp service for puppet to manage.
+
+
+##Limitations
+
+This module has been built on and tested against Puppet 2.7 and higher.
 
 The module has been tested on:
 
-* Enterprise Linux 5
-* Debian 6.0 
-* CentOS 5.4.
+* RedHat Enterprise Linux 5/6
+* Debian 6/7
+* CentOS 5/6.
 * Ubuntu 12.04
+* Gentoo
+* Arch Linux
+* FreeBSD
 
 Testing on other platforms has been light and cannot be guaranteed. 
 
-Development
-------------
+##Development
 
-Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
+Puppet Labs modules on the Puppet Forge are open projects, and community
+contributions are essential for keeping them great. We can’t access the
+huge number of platforms and myriad of hardware, software, and deployment
+configurations that Puppet is intended to serve.
 
-We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+We want to keep it as easy as possible to contribute changes so that our
+modules work in your environment. There are a few guidelines that we need
+contributors to follow so that we can have a chance of keeping on top of things.
 
 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
-
-Release Notes
---------------
-
-**0.2.0**
-
-0.2.0 is a backwards compatible feature and bug-fix release. Since
-0.1.0, support for Amazon Linux was added, fixes for style were
-implemented, and support was added for tinker_panic. tinker_panic
-will default to on when the fact is_virtual is true.