diff --git a/README.md b/README.md deleted file mode 100644 index ef30609..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -captcha_module - -Contrib module containing captcha logic. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..aa0c7c9 --- /dev/null +++ b/README.rst @@ -0,0 +1,32 @@ +Simple captcha module +===================== + +This module provides a simple captcha challenge (distorted characters). + +Installation +------------ + +- Make a new folder "captcha" in the **modules/oe/** directory of your shop installation. Download https://github.com/OXID-eSales/captcha_module/archive/master.zip and unpack it into this folder. **OR** +- Git clone the module to your OXID eShop **modules/oe/** directory: + + .. code:: bash + + git clone https://github.com/OXID-eSales/captcha_module.git captcha +- Activate the module in administration panel. + +Uninstallation +-------------- + +Disable the module in administration panel and/or delete the module folder. + + +License +------- + +Licensing of the software product depends on the shop edition used. The software for OXID eShop Community Edition +is published under the GNU General Public License v3. You may distribute and/or modify this software according to +the licensing terms published by the Free Software Foundation. Legal licensing terms regarding the distribution of +software being subject to GNU GPL can be found under http://www.gnu.org/licenses/gpl.html. The software for OXID eShop +Professional Edition and Enterprise Edition is released under commercial license. OXID eSales AG has the sole rights to +the software. Decompiling the source code, unauthorized copying as well as distribution to third parties is not +permitted. Infringement will be reported to the authorities and prosecuted without exception.