diff --git a/README.md b/README.md index 7dd2dfa..d14e139 100644 --- a/README.md +++ b/README.md @@ -14,30 +14,49 @@ * Silverstripe SpamProtection module * Mollom REST PHP Client -## Documentation +## Installation + +Extract all files into the 'mollom' folder under your Silverstripe root, or install using composer + +```bash +composer require silverstripe/mollom dev-master +``` + +If the mollom module causes an error in composer it may be necessary to explicitly add the +git url to your composer.json + +*composer.json* + +```json +{ + "repositories": [ + { + "type": "git", + "url": "https://github.com/Mollom/MollomPHP.git" + } + ] +} +``` + +## Configuration This module provides a FormField and SpamProtector classes for integration with the SpamProtection module in SilverStripe. Consult that module documentation for more information on how to setup and enable Mollom on your Forms. -To configure the use of this protector, use the Config API. - -*mysite/_config/spamprotection.yml* - --- - name: spamprotection - --- - FormSpamProtection: - default_spam_protector: MollomSpamProtector - -You will also need to sign up to [Mollom](http://mollom.com) to get API keys for +To configure the use of this protector, use the Config API. You will also +need to sign up to [Mollom](http://mollom.com) to get API keys for the website. Those should also been included through the Config API *mysite/_config/spamprotection.yml* - --- - name: spamprotection - --- - FormSpamProtection: - default_spam_protector: MollomSpamProtector - Mollom: - public_key: - private_key: \ No newline at end of file + +```yaml +--- +name: spamprotection +--- +FormSpamProtection: + default_spam_protector: MollomSpamProtector +Mollom: + public_key: + private_key: +```