diff --git a/README.md b/README.md index 5eb6efa..b159a10 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ Author - Frederic Guillot - License MIT +Requirements +------------ + +- Kanboard >= 1.0.29 +- Mailgun API credentials + Installation ------------ @@ -28,6 +34,13 @@ Note: Plugin folder is case-sensitive. Use Mailgun to send emails --------------------------- +### Use the user interface + +- Set the API credentials in **Settings > Integrations > Mailgun** +- Set the mail transport in **Settings > Email Settings** + +### Use the config file + Define those constants in your `config.php` file to send notifications with Mailgun: ```php @@ -44,8 +57,6 @@ define('MAILGUN_DOMAIN', 'YOUR_DOMAIN_CONFIGURED_IN_MAILGUN'); define('MAIL_FROM', 'sender-address-configured-in-mailgun@example.org'); ``` -You can also define the token is the application settings. - Use Mailgun to create tasks from emails ----------------------------------------