Skip to content

Commit

Permalink
Amending REMP Mailer module documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rootpd committed Jun 26, 2020
1 parent 3b0356e commit c51d610
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CRM REMP Mailer Module

REMP Mailer Module is an integration module connecting CRM with [REMP Mailer](https://github.com/remp2020/remp/tree/master/Mailer).

Module adds listener for `NotificationEvent` to send emails, and attaches widgets to allow users/admins to configure newsletter subscriptions and to see logs of all sent emails in administration.

## Installing module

We recommend using Composer for installation and update management.
Expand Down Expand Up @@ -30,4 +34,11 @@ remp_mailer:
api_token: abcdef123456789
```

If the configuration is incomplete, initialization will log an error to your configured logger and won't enable the module in CRM.
If the configuration is incomplete, initialization will log an error to your configured logger and won't enable the module in CRM.

When everything is ready, make sure you update CRM internal configuration by running following commands (they should always be part of your release process):

```
php bin/command.php api:generate_access
php bin/command.php application:seed
```

0 comments on commit c51d610

Please sign in to comment.