From c51d610d28c8d50559a1b969d5e4207f5bfe13ba Mon Sep 17 00:00:00 2001 From: Peter Dulacka Date: Fri, 26 Jun 2020 14:33:49 +0200 Subject: [PATCH] Amending REMP Mailer module documentation --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a07adc..3113623 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. \ No newline at end of file +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 +``` \ No newline at end of file