diff --git a/README.md b/README.md new file mode 100644 index 0000000..d50f223 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +Math Caption Addon +================== + +This addon for [Friendica](https://friendi.ca) adds a small mathematical task to the registration form. +If this task was not solved correctly, the the registration process fails. + +The task is randomly created combining two numbers between 1 and 10 with the addition, subtraction and multiplication operations. + +* Author: Tobias Diekershoff +* License: MIT + +Installation +------------ + +On the server running your Friendica change into your addon directory and clone this git repository. +You should then have all the needed files in the + + /addon/mathcaptcha + +directory of your Friendica installation. +Afterwards enable the addon in the admin panel as usual. + +Translations +------------ + +You can translate this addon by translating the strings in the `lang/C/messages.po` file and copy the resulting `messages.po` to the `lang/LNG_CODE` directory of your language.. +To generate the needed `strings.php` file for your language, use the tools [Friendica supplies](https://git.friendi.ca/friendica/friendica/src/branch/develop/doc/translations.md).