From 6fd559e9c99e85426d41358a5ed95c522c8031bc Mon Sep 17 00:00:00 2001
From: Raphaël Pinson <raphael.pinson@camptocamp.com>
Date: Fri, 12 Apr 2013 14:20:38 +0200
Subject: README

---
 README.md          | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 manifests/hosts.pp |  2 +-
 2 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eb129db..eb8ae5b 100644
--- a/README.md
+++ b/README.md
@@ -17,12 +17,60 @@ The `dhcp` class is a wrapper around `dhcp::server`:
 
 ### dhcp::server
 
+Installs a DHCP server:
+
+     class { 'dhcp::server':
+       opts => ['domain-name "toto.ltd"',
+                'domain-name-servers 192.168.21.1'],
+     }
+
 ## Definitions
 
 * dhcp::hosts
 * dhcp::shared\_network
 * dhcp::subnet
 
+### dhcp::hosts
+
+Creates a DHCP configuration for the given hosts:
+
+    dhcp::hosts { 'workstations':
+      subnet    => '192.168.1.0',
+       'hash_data' => {
+         'host1' => {
+           'interfaces' => {
+             'eth0'  => '00:11:22:33:44:55',
+             'wlan0' => '00:aa:bb:44:55:ff',
+           },
+         },
+         'host2' => {
+           'interfaces' => {
+             'eth1'  => '00:11:af:33:44:55',
+           },
+           'fixed_address' => 'foo.example.com',
+           'options'        => ['opt1'],
+         },
+       },
+    }
+
+### dhcp::shared\_network
+
+Creates a shared-network entry:
+
+    dhcp::shared_network { 'office':
+      subnets => ['192.168.1.0', '192.168.2.0'],
+    }
+
+### dhcp::subnet
+
+Creates a subnet:
+
+    dhcp::subnet {"10.27.20.0":
+      ensure     => present,
+      broadcast  => "10.27.20.255",
+      other_opts => ['filename "pxelinux.0";', 'next-server 10.27.10.1;'],
+    }
+
 ## Contributing
 
 Please report bugs and feature request using [GitHub issue
diff --git a/manifests/hosts.pp b/manifests/hosts.pp
index 1767a90..9c5d1b3 100644
--- a/manifests/hosts.pp
+++ b/manifests/hosts.pp
@@ -1,6 +1,6 @@
 # Definition: dhcp::hosts
 #
-# Creates a dhcp configuration for given hosts
+# Creates a dhcp configuration for the given hosts
 #
 # Parameters:
 #   ['template']       -  DHCP host template - default: 'dhcp/host.conf.erb'
-- 
cgit v1.2.3