Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
Make requirements actually required by composer.
  • Loading branch information
billythekid committed Oct 7, 2019
1 parent b2e88f6 commit beb375f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 10 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# recaptchaguest Changelog
# Recaptchaguest Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

## 1.0.0 - 2019-02-18
## 1.0.2 - 2019-10-07
### Fixed
- Added matt-west/craft-recaptcha and craftcms/guest-entries as composer requirements.

## 1.0.1 - 2019-02-18
### Fixed
- Fixed issue where empty recaptcha submissions were validating

Expand Down
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# recaptchaguest plugin for Craft CMS 3.x
# Recaptchaguest plugin for Craft CMS 3.x

Integrate [matt-west/craft-recaptcha](https://github.com/matt-west/craft-recaptcha) with [craftcms/guest-entries](https://github.com/craftcms/guest-entries)

## Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.
This plugin requires Craft CMS 3.0.0-RC1 or later.

## Installation

Expand All @@ -18,13 +18,23 @@ To install the plugin, follow these instructions.

composer require billythekid/recaptchaguest

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for recaptchaguest.
3. In the Control Panel, go to Settings → Plugins and click the “Install” button for recaptchaguest.

## recaptchaguest Overview
Note: Click install for recaptcha and guest entries if they're not installed yet. This plugin will make them available if they don't exist already however it won't install them into your Craft project for you.

## Recaptchaguest Overview

This plugin hooks together [matt-west/craft-recaptcha](https://github.com/matt-west/craft-recaptcha) with [craftcms/guest-entries](https://github.com/craftcms/guest-entries) to allow you to use the recaptcha validation in your guestentry submissions.

## Configuring recaptchaguest
## Configuring Recaptchaguest

There are no configuration options for this plugin however you will need to set up guest entries and recaptcha.

Follow the instructions to set up the [Recaptcha](https://github.com/matt-west/craft-recaptcha#configuring-craft-recaptcha) plugin.

See the [Guest Entries](https://github.com/craftcms/guest-entries) notes on settings and how to set up a guest entries form.

[Output the recaptcha on your form](https://github.com/matt-west/craft-recaptcha#using-craft-recaptcha).

There are no configuration options. Follow the instructions to install [matt-west/craft-recaptcha](https://github.com/matt-west/craft-recaptcha) plugin. If you select to validate contact form and this plugin is installed any guestentry form submissions will be validated against the recaptcha field.
(And will fail validation if the recaptcha code is not correct / is not supplied so make sure that the recaptcha field is [rendered on your form as per the instructions](https://github.com/matt-west/craft-recaptcha#using-craft-recaptcha))
If you select to validate a guest entries form and this plugin is installed any guestentry form submissions will be validated against the recaptcha field.
(And will fail validation if the recaptcha code is not correct / is not supplied)
4 changes: 3 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
}
],
"require": {
"craftcms/cms": "^3.0.0-RC1"
"craftcms/cms": "^3.0.0-RC1",
"craftcms/guest-entries": "^2.0",
"matt-west/craft-recaptcha": "^1"
},
"autoload": {
"psr-4": {
Expand Down

0 comments on commit beb375f

Please sign in to comment.