Merge pull request #311 from danquack/documentation

Updated documentation to use REFERENCE.md and minor data type updates

Author: Dan33l

README.md

@@ -35,57 +35,9 @@ Puppet module to manage OpenVPN servers and clients.
 
 * Version >= 4.10.0
 
-## Example
-
-```puppet
-  # add a server instance
-  openvpn::server { 'winterthur':
-    country      => 'CH',
-    province     => 'ZH',
-    city         => 'Winterthur',
-    organization => 'example.org',
-    email        => '[email protected]',
-    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 10.200.200.51',
-  }
-
-  # a revoked client
-  openvpn::client { 'client3':
-    server => 'winterthur',
-  }
-  openvpn::revoke { 'client3':
-    server => 'winterthur',
-  }
+## REFERENCES
 
-  # a server in client mode
-  file {
-    '/etc/openvpn/zurich/keys/ca.crt':
-      source => 'puppet:///path/to/ca.crt';
-    '/etc/openvpn/zurich/keys/zurich.crt':
-      source => 'puppet:///path/to/zurich.crt';
-    '/etc/openvpn/zurich/keys/zurich.key':
-      source => 'puppet:///path/to/zurich.key';
-  }
-  openvpn::server { 'zurich':
-    remote  => [ 'mgmtnet3.nine.ch 1197', 'mgmtnet2.nine.ch 1197' ],
-    require => [ File['/etc/openvpn/zurich/keys/ca.crt'],
-                 File['/etc/openvpn/zurich/keys/zurich.crt'],
-                 File['/etc/openvpn/zurich/keys/zurich.key'] ];
-
-  }
-```
+Please see [REFERENCE](REFERENCE.md) for more details.
 
 ## Example with hiera
 
@@ -188,6 +140,7 @@ Details of these ciphers and their uses can be found in the documentation links
 Note : TLS ciphers suites shipped with OSes ubuntu14.04 and debian8 are too old compared to our default values.
 If the openvpn server is running on these OSes with clients on more modern OSes, you will probably have to use custom value for option `tls_cipher`.
 
+
 ## Contributions
 
 This module is maintained by [Vox Pupuli](https://voxpupuli.org/). Voxpupuli
@@ -200,3 +153,4 @@ Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for more details.
 
 * Raffael Schmid <[email protected]>
 * Vox Pupuli Team
+* List of contributors https://github.com/danquack/puppet-openvpn/graphs/contributors