You are here

README.txt in Notify 8

NOTIFY README.txt
=================


CONTENTS OF THIS FILE
---------------------

* Introduction
* Requirements
* Installation
* Configuration
* Related projects & alternatives
* Maintainers


INTRODUCTION
------------

Notify is a simple, lightweight module for sending e-mail
notifications about new content and comments posted on a Drupal web
site.

* For a full description of the module, visit the project page:
  https://drupal.org/project/notify

* For more documentation about its use, visit the documentation page:
  https://www.drupal.org/documentation/modules/notify

* To submit bug reports and feature suggestions, or to track changes:
  https://drupal.org/project/issues/notify

If you enable node revisions (https://www.drupal.org/node/320614), the
notification e-mail will also mention the name of the last person to
edit the node.


REQUIREMENTS
------------

This module requires a supported version of Drupal and cron to be
running.


INSTALLATION
------------

1. Extract the notify module directory, including all its
   subdirectories, into directory where you keep contributed modules
   (e.g. /modules/).

2. Enable the notify module on the Modules list page.  The database
   tables will be created automagically for you at this point.

3. Modify permissions on the People » Permissions page.

   To set the notification checkbox default on new user registration
   form, or let new users opt in for notifications during
   registration, you must grant the anonymous user the right to access
   notify.

4. Configure general notification settings.  See the "Usage" section
   below for details.


CONFIGURATION
-------------

The administrative interface is at: Administration » Configuration »
People » Notify settings.

The Settings tab is for setting how often notifications are sent, and
for selecting notification by note type.  The Users tab is to review
and see per-user settings.

When setting how often notifications are sent, note that e-mail
updates can only happen as frequently as the cron is set to run.
Check your cron settings.

To manage your own notification preferences, click on the
"Notification settings" on your "My account" page.


RELATED PROJECTS & ALTERNATIVES
-------------------------------

Currently none for Drupal 8.


MAINTAINERS
-----------

Kjartan Mannes <kjartan@drop.org> is the original author.
Rob Barreca <rob@electronicinsight.com> was a previous maintainer.
Matt Chapman <matt@ninjitsuweb.com> is the project owner.
Gisle Hannemyr <gisle@hannemyr.no> maintains the Drupal 7 branch.

Marton Bodonyi (http://www.interactivejunky.com/),
Mark Lindsey,
John Oltman <john.oltman@sitebasin.com>,
Ward Poelmans <wpoely86@gmail.com>,
Ishmael Sanchez (http://ishmaelsanchez.com), and
Ajit Shinde (https://www.facebook.com/shinde.ajit)
contributed to the Drupal 7 port.
Vincent Rommelaars <vincent@hostplek.nl> contributed to the Drupal 8
port.

File

README.txt
View source
  1. NOTIFY README.txt
  2. =================
  3. CONTENTS OF THIS FILE
  4. ---------------------
  5. * Introduction
  6. * Requirements
  7. * Installation
  8. * Configuration
  9. * Related projects & alternatives
  10. * Maintainers
  11. INTRODUCTION
  12. ------------
  13. Notify is a simple, lightweight module for sending e-mail
  14. notifications about new content and comments posted on a Drupal web
  15. site.
  16. * For a full description of the module, visit the project page:
  17. https://drupal.org/project/notify
  18. * For more documentation about its use, visit the documentation page:
  19. https://www.drupal.org/documentation/modules/notify
  20. * To submit bug reports and feature suggestions, or to track changes:
  21. https://drupal.org/project/issues/notify
  22. If you enable node revisions (https://www.drupal.org/node/320614), the
  23. notification e-mail will also mention the name of the last person to
  24. edit the node.
  25. REQUIREMENTS
  26. ------------
  27. This module requires a supported version of Drupal and cron to be
  28. running.
  29. INSTALLATION
  30. ------------
  31. 1. Extract the notify module directory, including all its
  32. subdirectories, into directory where you keep contributed modules
  33. (e.g. /modules/).
  34. 2. Enable the notify module on the Modules list page. The database
  35. tables will be created automagically for you at this point.
  36. 3. Modify permissions on the People » Permissions page.
  37. To set the notification checkbox default on new user registration
  38. form, or let new users opt in for notifications during
  39. registration, you must grant the anonymous user the right to access
  40. notify.
  41. 4. Configure general notification settings. See the "Usage" section
  42. below for details.
  43. CONFIGURATION
  44. -------------
  45. The administrative interface is at: Administration » Configuration »
  46. People » Notify settings.
  47. The Settings tab is for setting how often notifications are sent, and
  48. for selecting notification by note type. The Users tab is to review
  49. and see per-user settings.
  50. When setting how often notifications are sent, note that e-mail
  51. updates can only happen as frequently as the cron is set to run.
  52. Check your cron settings.
  53. To manage your own notification preferences, click on the
  54. "Notification settings" on your "My account" page.
  55. RELATED PROJECTS & ALTERNATIVES
  56. -------------------------------
  57. Currently none for Drupal 8.
  58. MAINTAINERS
  59. -----------
  60. Kjartan Mannes is the original author.
  61. Rob Barreca was a previous maintainer.
  62. Matt Chapman is the project owner.
  63. Gisle Hannemyr maintains the Drupal 7 branch.
  64. Marton Bodonyi (http://www.interactivejunky.com/),
  65. Mark Lindsey,
  66. John Oltman ,
  67. Ward Poelmans ,
  68. Ishmael Sanchez (http://ishmaelsanchez.com), and
  69. Ajit Shinde (https://www.facebook.com/shinde.ajit)
  70. contributed to the Drupal 7 port.
  71. Vincent Rommelaars contributed to the Drupal 8
  72. port.