Update Readme for new module structure

1 files changed, 26 insertions, 102 deletions

diff --git a/Readme.markdown b/Readme.markdown
index d2a1f67..a6d0b68 100644
--- a/Readme.markdown
+++ b/Readme.markdown
@@ -8,110 +8,34 @@ OpenVPN module for puppet including client config/cert creation (tarball to down
 ## Supported OS
   - Debian Squeeze (should, as it works on Ubuntu Lucid)
   - Ubuntu 10.4, 12.04 (other untested)
-  - CentOS
+  - CentOS, RedHat
 
 ## Example
 
-    # add a server instance
-    openvpn::server {
-        "server1":
-            country      => "CH",
-            province     => "ZH",
-            city         => "Winterthur",
-            organization => "example.org",
-            email        => "root@example.org";
-    }
-
-    # configure server
-    openvpn::option {
-        "dev server1":
-            key    => "dev",
-            value  => "tun0",
-            server => "server1";
-        "script-security server1":
-            key    => "script-security",
-            value  => "3",
-            server => "server1";
-        "daemon server1":
-            key    => "daemon",
-            server => "server1";
-        "keepalive server1":
-            key    => "keepalive",
-            value  => "10 60",
-            server => "server1";
-        "ping-timer-rem server1":
-            key    => "ping-timer-rem",
-            server => "server1";
-        "persist-tun server1":
-            key    => "persist-tun",
-            server => "server1";
-        "persist-key server1":
-            key    => "persist-key",
-            server => "server1";
-        "proto server1":
-            key    => "proto",
-            value  => "tcp-server",
-            server => "server1";
-        "cipher server1":
-            key    => "cipher",
-            value  => "BF-CBC",
-            server => "server1";
-        "local server1":
-            key    => "local",
-            value  => $ipaddress,
-            server => "server1";
-        "tls-server server1":
-            key    => "tls-server",
-            server => "server1";
-        "server server1":
-            key    => "server",
-            value  => "10.10.10.0 255.255.255.0",
-            server => "server1";
-        "lport server1":
-            key    => "lport",
-            value  => "1194",
-            server => "server1";
-        "management server1":
-            key    => "management",
-            value  => "/var/run/openvpn-server1.sock unix",
-            server => "server1";
-        "comp-lzo server1":
-            key    => "comp-lzo",
-            server => "server1";
-        "topology server1":
-            key    => "topology",
-            value  => "subnet",
-            server => "server1";
-        "client-to-client server1":
-            key    => "client-to-client",
-            server => "server1";
-    }
-
-
-    # define clients
-    openvpn::client {
-        [ "client1.example.org", "client2.example.org" ]:
-            server      => "server1";
-    }
-
-    # add options to the client-config-dir file
-    openvpn::option {
-        "iroute server1 client1.example.org home network":
-            key    => "iroute",
-            value  => "192.168.0.0 255.255.255.0",
-            client => "client1.example.org",
-            server => "server1",
-            csc    => true;
-    }
-
-    # add an option to the client config
-    openvpn::option {
-        "ifconfig server1 client2.example.org":
-            key    => "ifconfig-push",
-            value  => "10.10.10.2 255.255.255.0",
-            client => "client2.example.org",
-            server => "server1";
-    }
+```puppet
+  # add a server instance
+  openvpn::server { 'winterthur':
+    country      => "CH",
+    province     => "ZH",
+    city         => "Winterthur",
+    organization => "example.org",
+    email        => "root@example.org",
+    server       => '10.200.200.0 255.255.255.0'
+  }
+
+  # define clients
+  openvpn::client { 'client1':
+    server => 'winterthur'
+  }
+  openvpn::client { 'client2':
+    server   => 'winterthur'
+  }
+  
+  openvpn::client_specific_config { 'client1':
+    server => 'winterthur',
+    ifconfig => '10.200.200.50 255.255.255.0'
+  }
+```
 
 Don't forget the [sysctl](https://github.com/luxflux/puppet-sysctl) directive ```net.ipv4.ip_forward```!
 
@@ -119,5 +43,5 @@ Don't forget the [sysctl](https://github.com/luxflux/puppet-sysctl) directive ``
 # Contributors
 
 These fine folks helped to get this far with this module:
-* [@jlk](https://github.com/jlk)
 * [@jlambert121](https://github.com/jlambert121)
+* [@jlk](https://github.com/jlk)