From: Ken Barber <ken@bob.sh>
Date: Wed, 15 Jun 2011 15:28:52 +0000 (+0200)
Subject: Added some more examples and README cleanup.
X-Git-Tag: v0.0.1~52
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=55a229969e01bfbdc1680f921797256530e805e4;p=puppet-modules%2Fpuppetlabs-firewall.git

Added some more examples and README cleanup.
---

diff --git a/README.markdown b/README.markdown
index 856923f..a358bcc 100644
--- a/README.markdown
+++ b/README.markdown
@@ -14,6 +14,25 @@ Please see the included Apache Software License for more legal details regarding
 
 From github, download the module into your modulepath on your Puppetmaster. If you are not sure where your module path is try this command:
 
-  puppet --configprint modulepath
+    puppet --configprint modulepath
 
 Depending on the version of Puppet, you may need to restart the puppetmasterd (or Apache) process before this module will work.
+
+### Quickstart
+
+Once the module is in the correct modulepath, you should be able to create some
+firewall rules like the below examples. Remember, that rules are lexically 
+ordered by the resource title at this point.
+
+Basic accept ICMP request example:
+
+    firewall { "000 accept all icmp requests":
+      proto => "icmp",
+      jump => "ACCEPT",
+    }
+
+Deny all:
+
+    firewall { "999 deny all other requests":
+      jump => "DENY",
+    }