From f27045ba93fc656d184ec3d25dfbfde29f3119cd Mon Sep 17 00:00:00 2001 From: Maxime Rainville Date: Wed, 27 May 2020 08:55:37 +1200 Subject: [PATCH] DOC Recommend installation of spamprotection (#966) DOC Recommend installation of spamprotection --- composer.json | 3 ++- readme.md | 8 +++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index 8cb0299..c2a17ac 100644 --- a/composer.json +++ b/composer.json @@ -47,7 +47,8 @@ }, "suggest": { "colymba/gridfield-bulk-editing-tools": "Allows for bulk management of form submissions", - "silverstripe/gridfieldqueuedexport": "Export large submission as CSV through queued jobs in the background" + "silverstripe/gridfieldqueuedexport": "Export large submission as CSV through queued jobs in the background", + "silverstripe/spamprotection": "Adds support for spam protection to your user forms" }, "scripts": { "lint": "phpcs code/ tests/", diff --git a/readme.md b/readme.md index 0b7d24a..6066248 100644 --- a/readme.md +++ b/readme.md @@ -27,11 +27,17 @@ See the "require" section of [composer.json](https://github.com/silverstripe/sil ## Installation ```sh -$ composer require silverstripe/userforms +composer require silverstripe/userforms ``` You'll also need to run `dev/build`. You should see a new page type in the CMS 'User Defined Form'. This has a new 'Form' tab which has your form builder. +## Spam protection + +This module does not include spam protection out of the box. Without it, it's likely that your submissions could contain a considerable amount of spam. For public facing forms it is encouraged you review and install the following module plus one of the recommended 'verification system' modules outlined in the README. + +Read the [SpamProtection Module README](https://github.com/silverstripe/silverstripe-spamprotection/) for details on how to configure this module. + ## Documentation * [Index](docs/en/index.md)