MINOR: Updated documentation and converted readme to markdown

README

@@ -1,30 +0,0 @@
-###############################################
-SpamProtection Module
-###############################################
-
-Maintainer Contact
------------------------------------------------
-Saophalkun Ponlu
-<phalkunz (at) silverstripe (dot) com>
-
-Will Rossiter
-<will (at) silverstripe (dot) com>
-
-Requirements
------------------------------------------------
-SilverStripe 2.3
-
-Documentation
------------------------------------------------
-http://doc.silverstripe.com/doku.php?id=modules:spamprotection
-
-Installation Instructions
------------------------------------------------
-See INSTALL
-
-Usage Overview
------------------------------------------------
-See INSTALL
-
-Known issues
------------------------------------------------

README.md

@@ -0,0 +1,26 @@
+# SpamProtection Module
+
+## Maintainer Contact
+ * Saophalkun Ponlu
+   <phalkunz (at) silverstripe (dot) com>
+
+ * Will Rossiter
+   <will (at) silverstripe (dot) com>
+
+## Requirements
+
+SilverStripe 2.3.2 or greater
+
+## Documentation
+
+http://doc.silverstripe.org/modules:spamprotection
+
+## Installation Instructions
+
+See docs/Install
+
+## Usage Overview
+
+See docs/Install
+
+## Known issues

docs/Install.md

@@ -1,12 +1,9 @@
-SilverStripe SpamProtection Module 0.1 beta
+# Spam Protection Module Installation
-=======================================
 
-
+## Install
-INSTALLATION
-------------
 
 1. Unzip this file (spamprotection-0.1.tar.gz) inside your SilverStripe installation directory.
-It should be at the same level as 'jsparty', 'cms' and 'sapphire' modules.
+It should be at the same level as the 'cms' and 'sapphire' modules.
 
 2. Ensure the directory name for the module is 'spamprotection'. 
 
@@ -17,22 +14,28 @@ inside project directory (typically 'mysite/_config.php') with your favourite te
 Read the instructions below to setup the initial configuration of the module.
 
 
-SETTING UP THE MODULE (in 'mysite/_config.php')
+## Configuring
-------------------------------------------------------
 
-Before putting the following code in '_config.php', make sure you have a subclass of 'SpamProtectorField' installed or written. One 
+Before putting the following code in '_config.php', make sure you have a additional protector class installed. 
-example of 'SpamProtector' subclass is 'MollomField'.
+The SpamProtector module only provides the backbone. To make use of the module you have to have an additional protector
+such as Mollom or Recaptcha. Both of these modules can be downloaded off the SilverStripe.org website. 
 
-SpamProtectorManager::set_spam_protector('MollomSpamProtector');
+	SpamProtectorManager::set_spam_protector('MollomSpamProtector');
 
 
-UPDATING A FORM TO INCLUDE THE SPAM PROTECTOR FIELD 
+## Updating a form to include Spam Protection
----------------------------------------------------
 
 This following code should appear after the form creation. 
 
-$protector = SpamProtectorManager::update_form($form, 'Message');
+	// your existing form code here...
+	$form = new Form( .. );
+	
+	// add this line
+	$protector = SpamProtectorManager::update_form($form, 'Message');
 
 This code add an instance of a 'SpamProtectorField' class specified in SETTING UP THE MODULE section. The newly created field will have 
 MollomField field. The first parameter is a Form object in which the field will be added into and the second parameter tells 
 SpamProtectorManagor to place the new field before a field named 'Message'. 
+
+
+## Using Spam Protection with User Forms