Commit 4a5de631 authored by elachlan's avatar elachlan
Browse files

Issue #2631636 by elachlan, Prashant.c, harsha012: Improve README.md file for CAPTCHA

parent e783438a
......@@ -3,27 +3,27 @@ CAPTCHA module for Drupal
[![Build Status](https://travis-ci.org/chuva-inc/captcha.svg?branch=8.x-1.x)](https://travis-ci.org/chuva-inc/captcha)
[![Code Climate](https://codeclimate.com/github/chuva-inc/captcha/badges/gpa.svg)](https://codeclimate.com/github/chuva-inc/captcha)
Description
------------
captcha.module is the basic CAPTCHA module, offering general CAPTCHA
administration and a simple maths challenge.
DESCRIPTION
-----------
captcha.module is the basic CAPTCHA module, offering general CAPTCHA
administration and a simple maths challenge.
Sub module
---------
image_captcha.module offers an image based challenge.
SUB MODULE
----------
image_captcha.module offers an image based challenge.
Installation:
--------------
1. Extract the tar.gz into your 'modules' or directory and copy to modules folder.
2. Go to "Extend" after successfully login into admin.
3. Enable the module at 'administer >> modules'.
INSTALLATION:
-------------
1. Extract the tar.gz into your 'modules' or directory and copy to modules folder.
2. Go to "Extend" after successfully login into admin.
3. Enable the module at 'administer >> modules'.
Dependencies
DEPENDENCIES
------------
The basic CAPTCHA module has no dependencies, nothing special is required.
Conflicts/known issues
-----------------------
CONFLICTS/KNOWN ISSUES
----------------------
CAPTCHA and page caching do not work together currently.
However, the CAPTCHA module does support the Drupal core page
caching mechanism: it just disables the caching of the pages
......@@ -32,14 +32,23 @@ Conflicts/known issues
won't work, and you get error messages like 'CAPTCHA validation
error: unknown CAPTCHA session ID'.
Configuration
--------------
CONFIGURATION
-------------
The configuration page is at admin/config/people/captcha,
where you can configure the CAPTCHA module
and enable challenges for the desired forms.
You can also tweak the image CAPTCHA to your liking.
Uninstallation
UNINSTALLATION
--------------
1. Disable the module from 'administer >> modules'.
2. Uninstall the module
1. Disable the module from 'administer >> modules'.
2. Uninstall the module
MAINTAINERS
-----------
Current maintainers:
* Fabiano Sant'Ana (wundo) - https://www.drupal.org/u/wundo
* Andrii Podanenko (podarok) - https://www.drupal.org/u/podarok
* soxofaan - https://www.drupal.org/u/soxofaan
* Lachlan Ennis (elachlan) - https://www.drupal.org/u/elachlan
* Rob Loach (RobLoach) - https://www.drupal.org/u/robloach
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment