diff --git a/README.md b/README.md index 1871ce5..a71d3f2 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,8 @@ IPs are also released after a certain expire amount of time. #### With Composer Add this plugin `dsoares/rcguard` to the `require` section of your Roundcube -`composer.json`, run composer update and enable rcguard in the main Roundcube configuration file. +`composer.json`, run composer update and enable rcguard in the main Roundcube +configuration file.
OR just run: composer require dsoares/rcguard @@ -28,13 +29,15 @@ Copy `config.inc.php.dist` to `config.inc.php` and modify as necessary. #### Manually -Place the contents of this directory under `plugins/rcguard` and enable rcguard in the main -Roundcube configuration file. +Place the contents of this directory under `plugins/rcguard` and enable rcguard +in the main Roundcube configuration file. Copy `config.inc.php.dist` to `config.inc.php` and modify as necessary. Use the files under `SQL/` to create the database schema required for rcguard. The table should be created in the database used by Roundcube. +**NOTE**: If you use the Roundcube `db_prefix` config option, you must rename +the table `rcguard` accordingly. ## Customizing reCAPTCHA @@ -45,7 +48,7 @@ You may customize the following in the `config.inc.php` file: - the v2 widget theme: `light` or `dark`; - the v2 widget size: `normal` or `compact`. -For more information about the widget please check the [documentation about reCAPTCHA](recaptcha-doc). +For more information about the widget please check the [documentation about reCAPTCHA][recaptcha-doc]. The plugin configuration file has several other options you may configure, please take at look. @@ -61,7 +64,7 @@ Since May 2018, you can define a proxy (anonymous or authenticated) to request t ## Contact -The original author of this plugin was [Denny Lin](dennylin). I forked it some +The original author of this plugin was [Denny Lin][dennylin]. I forked it some years ago to 1) use reCAPTCHA v2.0, 2) add the larry skin and 3) because the project issues were taking too long to be answered. Also, the original project was not updated since 2015 and many things have changed in the meantime in Roundcube's API. @@ -80,7 +83,7 @@ Email: [Diana Soares][email] ## License -This plugin is distributed under the GPLv3+ license. +This plugin is distributed under the GPL-3.0+ license. This plugin also contains a PHP library for reCAPTCHA that is distributed under its own license. See the library file for the exact details. diff --git a/composer.json b/composer.json index 454e079..92ac758 100644 --- a/composer.json +++ b/composer.json @@ -7,12 +7,6 @@ "version": "1.3.0", "license": "GPL-3.0+", "authors": [ - { - "name": "Denny Lin", - "email": "dennylin93@hs.ntnu.edu.tw", - "homepage": "https://github.com/dennylin93", - "role": "Original developer" - }, { "name": "Diana Soares", "email": "diana.soares@gmail.com",