gotta have a readme

1 files changed, 50 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f70ccd3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# Puppet Samba Module
+
+Module for provisioning Samba
+
+Tested on Ubuntu 12.04, patches to support other operating systems are welcome.
+
+## Installation
+
+Clone this repo to your Puppet modules directory
+
+  git clone git://github.com/ajjahn/puppet-samba.git samba
+
+## Usage
+
+Tweak and add the following to your site manifest:
+
+  node 'server.example.com' {
+    class {'samba::server':
+      workgroup => 'example',
+      server_string => "Example Samba Server",
+      interfaces => "eth0 lo",
+      security => 'share'
+    }
+
+    samba::server::share {'example-share':
+      comment => 'Example Share',
+      path => '/path/to/share',
+      guest_only => true
+      guest_ok => true,
+      guest_account => "guest",
+      browsable => false,
+      create_mask => 0777,
+      force_create_mask => 0777,
+      directory_mask => 0777,
+      force_directory_mask => 0777,
+      force_group => 'group',
+      force_user => 'user',
+      copy => 'some-other-share',
+    }
+  }
+
+Most configuration options are optional.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request