Add first version of README.rst.

This commit is contained in:
hkreuter 2016-03-21 16:06:24 +01:00
parent 7a4ae598f6
commit 956a9143b4
2 changed files with 32 additions and 3 deletions

View File

@ -1,3 +0,0 @@
captcha_module
Contrib module containing captcha logic.

32
README.rst Normal file
View File

@ -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.