Updated readme slightly.

Author: dave83649

README.md

@@ -3,6 +3,34 @@
 This repository contains the firewall engine of Patchstack.
 It can be implemented inside of other content management systems to provide firewall functionality.
 
+## Implementation ##
+Implementation is simple, and examples can be seen in `/tests/FirewallTest.php`
+
+Example firewall rules can be seen in `/tests/data/Rules.json`
+
+Example whitelist rules can be seen in `/tests/data/Whitelist.json`
+
+```php
+use Patchstack\Processor;
+use Patchstack\Extensions\WordPress\Extension;
+
+// Load the firewall rules, whitelist rules and settings from some place.
+$firewallRules = [];
+$whitelistRules = [];
+$settings = [];
+
+// Setup the firewall rules processor.
+$firewall = new Processor(
+    new Extension(),
+    $firewallRules,
+    $whitelistRules,
+    $settings
+);
+
+// And launch it. If a request was a hit with a firewall rule, it will automatically stop execution.
+$firewall->launch();
+```
+
 ## Functionality ##
 This firewall engine can parse and understand JSON based firewall rules. These JSON based firewall rules allow you to match against parameters, match against multiple conditions being true, apply mutations (e.g., JSON decode or base64 decode) to payloads and compare against output of PHP functions.
 

src/Processor.php

@@ -132,7 +132,7 @@ public function launch($mustExit = true)
             return true;
         }
 
-        // Determine if we have a valid configuration password.
+        // Determine if we have a valid configuration passed.
         if (!is_array($this->firewallRules) || !is_array($this->whitelistRules)) {
             return true;
         }
@@ -158,10 +158,10 @@ public function launch($mustExit = true)
                 continue;
             }
 
-            // Transform rule object to array, then execute the firewall rule.
+            // Execute the firewall rule.
             $rule_hit = $this->executeFirewall($rule['rules']);
 
-            // If the payload did not match the rule, continue.
+            // If the payload did not match the rule, continue on to the next rule.
             if (!$rule_hit) {
                 continue;
             }