Reorganise files in ConfirmEdit

[toast/cookiecaptcha.git] / README

diff --git a/README b/README
index ce52f206f5a32db51afbe98ee1995b52c4308497..f23fbb2b7752c8da28ed063c28c011e57a04065b 100644 (file)
--- a/README
+++ b/README
@@ -1,76 +1,38 @@
-MATHCAPTCHA PLUGIN FOR MEDIAWIKI
+ConfirmEdit extension for MediaWiki
 
-1. Overview
-2. Requirements
-3. Installing the plugin
-4. Customising captcha behaviour
-5. Change log
-6. Feedback
-7. References
+This extension provides various CAPTCHA tools for MediaWiki, to allow
+for protection against spambots and other automated tools.
 
-== 1. Overview ==
+For more information, see the extension homepage at:
+http://www.mediawiki.org/wiki/Extension:ConfirmEdit
 
-The MathCaptcha plugin is an alternative captcha[1] mechanism which can
-be used in conjunction with the ConfirmEdit extension[2] to provide a
-more convenient means of blocking or throttling automated editing.
+== Overview ==
 
-The method used to generate the captcha images, and the formatting of
-said images, means that the captchas will not, at this time, defeat a
-tool which is designed to break them; however, casual mass-registration
-or mass-spamming attempts will be dissuaded.
+The following modules are included in ConfirmEdit:
 
-== 2. Requirements ==
+* SimpleCaptcha - users have to solve an arithmetic math problem
+* MathCaptcha - users have to solve a math problem that's displayed as
+an image
+* FancyCaptcha - users have to identify a series of characters, displayed
+in a stylized way
+* QuestyCaptcha - users have to answer a question, out of a series of
+questions defined by the administrator(s)
+* ReCaptcha - users have to identify a series of characters, either
+visually or audially, from a widget provided by the reCAPTCHA service
 
-The plugin requires
+== License ==
 
-* Working support for TeX within MediaWiki (using the standard TexVC
-  software)[3]
-* ConfirmEdit extension
+ConfirmEdit is published under the GPL license.
+ 
+== Authors ==
 
-== 3. Installing the plugin ==
+The main framework, and the SimpleCaptcha and FancyCaptcha modules, were
+written by Brion Vibber.
 
-Check the plugin out from Subversion[4] (and check out the ConfirmEdit
-extension, if you don't have it installed) and place the files in your
-extensions/ directory, within your wiki root.
+The MathCaptcha module was written by Rob Church.
 
-Edit LocalSettings.php and add the following lines near the bottom of the
-file, above the closing ?> tag, if any:
+The QuestyCaptcha module was written by Benjamin Lees.
 
-       require_once( 'extensions/ConfirmEdit.php' );
-       require_once( 'extensions/MathCaptcha.php' );
-       $wgCaptchaClass = 'MathCaptcha';
+The reCAPTCHA module was written by Mike Crawford and Ben Maurer.
 
-This installs ConfirmEdit and instructs it to use the MathCaptcha plugin.
-The default settings for ConfirmEdit are used. At this point, no further
-action is required to have the plugin work for user registration or edits
-which add new external links to a page.
-
-== 4. Customising captcha behaviour ==
-
-A number of settings relating to the ConfirmEdit extension can be used to alter
-the attitude of the captcha, including those actions for which it appears,
-users who do not have to pass a captcha, etc. See the ConfirmEdit.php file for
-information on this.
-
-As an example, to throw a captcha for all edits, add the following line to
-LocalSettings.php:
-
-       $wgCaptchaTriggers['edit'] = true;
-
-== 5. Change log ==
-
-12/06/2006
-1.0
-       Initial release
-
-== 6. Feedback ==
-
-Feedback on the MathCaptcha plugin is welcomed at <robchur@gmail.com>. To report bugs
-with the ConfirmEdit extension, please use http://bugzilla.wikimedia.org.
-
-== 7. References ==
-
-i. http://en.wikipedia.org/wiki/Captcha
-ii. http://www.mediawiki.org/wiki/Extension:ConfirmEdit
-iii. http://www.mediawiki.org/wiki/Manual:Enable_TeX
-iv. http://www.mediawiki.org/wiki/Subversion
+Additional maintenance work was done by Yaron Koren.