Update README and use 2-space indent

ChangeLog

@@ -1,3 +1,7 @@
+2013-05-20 - 0.1.2
+* Update README and use markdown.
+* Change to 2-space indent.
+
 2012-04-20 - 0.1.1
 * Add hide_file support.
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2011 Matthias Saou
+Copyright (C) 2011-2013 Matthias Saou
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

Modulefile

@@ -1,9 +1,9 @@
 name 'thias-vsftpd'
-version '0.1.1'
-source 'git://github.com/thias/puppet-modules/modules/vsftpd'
+version '0.1.2'
+source 'git://github.com/thias/puppet-vsftpd'
 author 'Matthias Saou'
 license 'Apache 2.0'
 summary 'vsftpd FTP server'
 description "Install and enable the vsftpd FTP server, a secure and fast FTP
     server for UNIX-like systems."
-project_page 'http://glee.thias.es/puppet'
+project_page 'https://github.com/thias/puppet-vsftpd'

README.md

@@ -0,0 +1,23 @@
+# puppet-vsftpd
+
+## Overview
+
+This module enables and configures a vsftpd FTP server instance.
+
+* `vsftpd` : Enable and configure the vsftpd FTP server
+
+## Examples
+
+With all of the module's default settings :
+
+    include vsftpd
+
+Tweaking a few settings :
+
+    class { 'vsftpd':
+      anonymous_enable  => 'NO',
+      write_enable      => 'YES',
+      ftpd_banner       => 'Marmotte FTP Server',
+      chroot_local_user => 'YES',
+    }
+

manifests/init.pp

@@ -7,61 +7,61 @@
 # Sample Usage :
 #  include vsftpd
 #  class { 'vsftpd':
-#      anonymous_enable  => 'NO',
-#      write_enable      => 'YES',
-#      ftpd_banner       => 'Marmotte FTP Server',
-#      chroot_local_user => 'YES',
+#    anonymous_enable  => 'NO',
+#    write_enable      => 'YES',
+#    ftpd_banner       => 'Marmotte FTP Server',
+#    chroot_local_user => 'YES',
 #  }
 #
 class vsftpd (
-    $anonymous_enable = 'YES',
-    $local_enable = 'YES',
-    $write_enable = 'YES',
-    $local_umask = '022',
-    $anon_upload_enable = 'NO',
-    $anon_mkdir_write_enable = 'NO',
-    $dirmessage_enable = 'YES',
-    $xferlog_enable = 'YES',
-    $connect_from_port_20 = 'YES',
-    $chown_uploads = 'NO',
-    $chown_username = false,
-    $xferlog_file = '/var/log/vsftpd.log',
-    $xferlog_std_format = 'YES',
-    $idle_session_timeout = '600',
-    $data_connection_timeout = '120',
-    $nopriv_user = false,
-    $async_abor_enable = 'NO',
-    $ascii_upload_enable = 'NO',
-    $ascii_download_enable = 'NO',
-    $ftpd_banner = false,
-    $chroot_local_user = 'NO',
-    $chroot_list_enable = 'NO',
-    $chroot_list_file = '/etc/vsftpd/chroot_list',
-    $ls_recurse_enable = 'NO',
-    $listen_port = false,
-    $pam_service_name = 'vsftpd',
-    $userlist_enable = 'YES',
-    $tcp_wrappers = 'YES',
-    $hide_file = false,
-    $hide_ids = 'NO',
-    $setproctitle_enable = 'NO',
-    $text_userdb_names = 'NO'
+  $anonymous_enable        = 'YES',
+  $local_enable            = 'YES',
+  $write_enable            = 'YES',
+  $local_umask             = '022',
+  $anon_upload_enable      = 'NO',
+  $anon_mkdir_write_enable = 'NO',
+  $dirmessage_enable       = 'YES',
+  $xferlog_enable          = 'YES',
+  $connect_from_port_20    = 'YES',
+  $chown_uploads           = 'NO',
+  $chown_username          = false,
+  $xferlog_file            = '/var/log/vsftpd.log',
+  $xferlog_std_format      = 'YES',
+  $idle_session_timeout    = '600',
+  $data_connection_timeout = '120',
+  $nopriv_user             = false,
+  $async_abor_enable       = 'NO',
+  $ascii_upload_enable     = 'NO',
+  $ascii_download_enable   = 'NO',
+  $ftpd_banner             = false,
+  $chroot_local_user       = 'NO',
+  $chroot_list_enable      = 'NO',
+  $chroot_list_file        = '/etc/vsftpd/chroot_list',
+  $ls_recurse_enable       = 'NO',
+  $listen_port             = false,
+  $pam_service_name        = 'vsftpd',
+  $userlist_enable         = 'YES',
+  $tcp_wrappers            = 'YES',
+  $hide_file               = false,
+  $hide_ids                = 'NO',
+  $setproctitle_enable     = 'NO',
+  $text_userdb_names       = 'NO'
 ) {
 
-    package { 'vsftpd': ensure => installed }
+  package { 'vsftpd': ensure => installed }
 
-    service { 'vsftpd':
-        require   => Package['vsftpd'],
-        enable    => true,
-        ensure    => running,
-        hasstatus => true,
-    }
+  service { 'vsftpd':
+    require   => Package['vsftpd'],
+    enable    => true,
+    ensure    => running,
+    hasstatus => true,
+  }
 
-    file { '/etc/vsftpd/vsftpd.conf':
-        require => Package['vsftpd'],
-        content => template('vsftpd/vsftpd.conf.erb'),
-        notify  => Service['vsftpd'],
-    }
+  file { '/etc/vsftpd/vsftpd.conf':
+    require => Package['vsftpd'],
+    content => template('vsftpd/vsftpd.conf.erb'),
+    notify  => Service['vsftpd'],
+  }
 
 }