Pragya Shroti
--- a/README.txt → README.md

+ 33

− 33
+++ b/README.txt → README.md

+ 33

− 33
-CONTENTS OF THIS FILE
+## CONTENTS OF THIS FILE
 ---------------------

 * Introduction
 @@ -11,20 +11,20 @@ CONTENTS OF THIS FILE
 * Maintainers
 * Sponsoring

-INTRODUCTION
+## INTRODUCTION
 ------------

 Entity activity allow to configure and generate any kind of notifications / logs
 on any content entity type for each of theses operations : create, update and
 delete.

-REQUIREMENTS
+## REQUIREMENTS
 ------------

 Entity Activity requires the Token module, and the Core modules Text and
 Serialization.

-SIMILAR MODULES
+## SIMILAR MODULES
 -------------------

 You can use the message stack and the flag module to implement similar
 @@ -32,19 +32,19 @@ behavior on a Drupal project. Where as these two modules can do a lot more than
 a notification/log system, Entity Activity module is completely focused on this
 feature, and by this fact is easier to install and configure.

-INSTALLATION
+## INSTALLATION
 ------------

 * Install as you would normally install a contributed Drupal module. See:
   https://www.drupal.org/docs/8/extending-drupal-8/installing-modules
   for further information.

-CONFIGURATION
+## CONFIGURATION
 -------------

 All the configuration happens under /admin/config/content/entity-activity.

-General settings:
+### General settings:
 * Configure the content entity type on which you want enable subscription.
 * Configure a purge if needed for the logs generated.

 @@ -58,18 +58,18 @@ General settings:
 See the issue https://www.drupal.org/project/entity_activity/issues/3063918 for
 a complete example.

-Generators and Logs generators :
+### Generators and Logs generators :
 * Create and configure as many as you need config entities Generators. Each of
   theses config entities created have all the plugins "Log generator" available
   on the project. Enable and configure the relevant plugins for each config
   entity generator.

-Configure Content entity types.
+### Configure Content entity types.
  * For each of the content entity types enabled in the general settings, you
    can enabled the extra field "Subscribe on" in the relevant view mode. This
    extra field will allow user to subscribe on each entities.

-Configure Log entities
+### Configure Log entities
  * You can enable on the log entity (manage display mode) the extra field
    "Remove log". This extra field allow owner of logs to delete them from their
    account.
 @@ -77,19 +77,19 @@ Configure Log entities
    "Log Read / Unread". This formatter exposes a widget which allow users
    to mark the logs as read / unread.

-Configure subscription entities
+### Configure subscription entities
  * You can enable on the subscription entity (manage display mode) the extra
    field "Remove subscription". This extra field allow owner of a subscription
    to delete it.

-Log and subscription entity type
-  Globally you can add and configure others fields on theses entity types. As
+### Log and subscription entity type
+  * Globally you can add and configure others fields on theses entity types. As
  you can do for node. But you have to then to manage how theses fields will be
  set programmatically. Relevant Events are dispatched for each hook during
  the CRUD cycle (presave, postsave, update, insert, delete, etc.)

-Multilingual support
-  Subscriptions are multilingual aware. So a user can subscribe on content for
+### Multilingual support
+  * Subscriptions are multilingual aware. So a user can subscribe on content for
  each translations available. Log messages are generated in the current
  language when the operation is performed. You can force a log message to be
  generated in the user's preferred language (if set), by checking the
 @@ -98,13 +98,13 @@ Multilingual support
  a subscription. Use it only if you really need log messages to be generated
  in the user's preferred language.

-Plugin type "Log generator"
-  You can add your own plugin and override some of the methods responsible
+### Plugin type "Log generator"
+  * You can add your own plugin and override some of the methods responsible
  to generate the logs if the needs of a project are too specific. The module
  ship by default 4 plugins, for each main content entity type of Drupal Core :
  Node, User, Taxonomy term, Comment.

-Permissions
+### Permissions
  * Configure the permissions provided by the module to allow users to
    (un)subscribe on entities, to view / remove their subscription and their
    logs which have been generated according their subscriptions.
 @@ -117,7 +117,7 @@ This module ship with some useful widgets :
  * A Views area Plugin which provide a button which allow to mark all the
      unread logs as read. Only on views based on the Log entity type of course.

-List subscriptions per entity
+### List subscriptions per entity
  On each content entity enable for Entity Activity, this module a Local Task
  named "Subscribers" on their canonical route. This allows users with relevant
  permissions ("view entities subscribers" or "view entities subscribers on
 @@ -135,7 +135,7 @@ List subscriptions per entity
  listing as you need. All subscriptions entities are available as variable.


-MAIL DIGEST FEATURE
+### MAIL DIGEST FEATURE

 Since the beta8 version, the module ships a new sub module Entity Activity Mail.
 A blog post introduces this feature.
 @@ -148,7 +148,7 @@ All the configuration happens under
 /admin/config/content/entity-activity/mail-settings.


-General settings:
+### General settings:
  * You can enable / disable sending logs report by mail.
  * You can configure to only send by mail the unread logs. Otherwise all logs
  not already sent will be included into the report.
 @@ -158,7 +158,7 @@ General settings:
  least every hour, and to run the cron from your server.
  * You can log any report sent with the corresponding option.

-Mail settings
+### Mail settings
 You can configure the following options for the emails sent.
  * The mail from used (default to site mail if empty)
  * A body (token supported for the user entity) displayed above the logs
 @@ -172,7 +172,7 @@ Mail settings
  You should consider to install the Swiftmailer module to send logs report with
  HTML mail. Otherwise logs report mails will be sent as plain text.

-Theming
+### Theming

  You can override the template used to render the logs template. An array of
  all the log entities included in the report is available in the template,
 @@ -181,24 +181,24 @@ Theming
  by this module) is also included in the template (used as the default).


-Permissions
+### Permissions

  Configure the permissions provided by the module to allow users to configure Entity Activity Mail
  Usage

-Frequency
+### Frequency

  Users must select a frequency from their profile. If none frequency is
  selected, the user will not receive any logs report by mail. The user can
  choose as frequency :

-    *Immediately : An email is sent for each log created for the user
-    *Daily : A daily report will be sent to the user.
-    *Weekly : A weekly report will be sent to the user.
-    *Monthly : A monthly report will be sent to the user.
+    * Immediately : An email is sent for each log created for the user
+    * Daily : A daily report will be sent to the user.
+    * Weekly : A weekly report will be sent to the user.
+    * Monthly : A monthly report will be sent to the user.


-MASS SUBSCRIBE FEATURE
+### MASS SUBSCRIBE FEATURE

 Since the beta12 version, the module ships a new sub module Entity Activity Mass
 Subscribe.
 @@ -221,11 +221,11 @@ Also, as you can mass subscribe users on an entity, a reverse option is
 available on the form, allowing you to mass *unsubscribe* users from the entity.


-TROUBLESHOOTING
+## TROUBLESHOOTING
 ---------------


-FAQ
+## FAQ
 ---

 * Can I have logs generated for new content ? And how users can subscribe to be
 @@ -238,7 +238,7 @@ FAQ
  There is no way actually to be globally notified. This need a "global"
  subscription which could be implemented if needed in the futur.

-MAINTAINERS
+## MAINTAINERS
 -----------

 Current maintainer: