diff --git a/README.md b/README.md index 10071d6..1ffe429 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,50 @@ +CONTENTS OF THIS FILE +--------------------- + +* Introduction +* Requirements +* Installation +* Configuration +* FAQ +* Maintainers + INTRODUCTION ------------ Conditional message is designed to display custom messages to a targeted -audience. Some conditions are available by default to cover common cases. -Integration with other modules to expand its functionality is underway. +audience on a given condition. Some conditions are available by default to cover +common cases. Integration with other modules to expand its functionality is +underway. + + +REQUIREMENTS +------------ + +This module has no required dependencies outside of Drupal core. + INSTALLATION ------------ -Install like any other module. See the documentation for details: -https://www.drupal.org/docs/7/extending-drupal-7/installing-contributed-modules-find-import-enable-configure-drupal-7 +Install like any other module. Visit the documentation for details: +https://www.drupal.org/node/1897420 + CONFIGURATION ------------- -Check the boxes of the conditions you would like to use to trigger the message. -As conditions are checked their corresponding configurations are displayed at -the bottom. It is also possible to configure the message background colour, the -font colour, the position of the message (top or bottom of the page) and the -html element to use as a container. You can target a container by entering the -id or class as in CSS. The default is to use the #page-wrapper as the container. +1. Navigate to Administration > Extend and enable the module. +2. Navigate to Administration > Configuration > User Interface > Conditional + Message. +3. Select the conditions upon which the message will be triggered. +4. Enter the message to be displayed. +5. Optionally: Select a different color or position for the message. +6. Save configuration. + +You can target a container by entering the id or class as in CSS. The default +is to use the #page-wrapper as the container. + FAQ --- @@ -36,8 +60,8 @@ Q: How does the module checks for content types? A: The content types are checked via JS by searching in the body tag a class that corresponds to "node-type-[your content type]". + MAINTAINERS ----------- -Current maintainers: - * William Ranvaud (wranvaud) - https://www.drupal.org/user/1058108 +* William Ranvaud (wranvaud) - https://www.drupal.org/user/1058108