Skip to content

Commit

Permalink
Fix README.
Browse files Browse the repository at this point in the history
  • Loading branch information
dsoares committed Nov 29, 2020
1 parent 7df0857 commit 8f3a19c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<br>OR just run:

composer require dsoares/rcguard
Expand All @@ -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
Expand All @@ -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.

Expand All @@ -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.
Expand All @@ -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.
Expand Down
6 changes: 0 additions & 6 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@
"version": "1.3.0",
"license": "GPL-3.0+",
"authors": [
{
"name": "Denny Lin",
"email": "[email protected]",
"homepage": "https://github.com/dennylin93",
"role": "Original developer"
},
{
"name": "Diana Soares",
"email": "[email protected]",
Expand Down

0 comments on commit 8f3a19c

Please sign in to comment.