diff --git a/README.txt b/README.txt index 4b1141b..b0ff25e 100644 --- a/README.txt +++ b/README.txt @@ -1,3 +1,16 @@ +CONTENTS OF THIS FILE +--------------------- + + * Introduction + * Requirements + * Installation + * Recommended Modules + * Configuration + * Maintainers + + +INTRODUCTION +------------ You may want to visit the handbook of this module, at: @@ -49,27 +62,41 @@ written by Earl Miles. Flag was written by Nathan Haug and mystery man Mooffie. This module built by robots: http://www.lullabot.com -Recommended Modules -------------------- -- Views -- Session API -- Token, which is required for Flag to provide tokens on flagged entities. -Installation +REQUIREMENTS +------------ + +No special requirements + + +INSTALLATION ------------ + +Install as you would normally install a contributed Drupal module. See: +https://drupal.org/documentation/install/modules-themes/modules-7 for further +information. + 1) Copy the flag directory to the modules folder in your installation. 2) Enable the module using Administer -> Modules (/admin/modules) -Optional Installation ---------------------- -1) The ability for anonymous users to flag content is provided by the Session - API module, available at http://drupal.org/project/session_api. + * Optional Installation + - The ability for anonymous users to flag content is provided by the Session + API module, available at http://drupal.org/project/session_api. + + +RECOMMENDED MODULES +------------------- +- Views +- Session API +- Token, which is required for Flag to provide tokens on flagged entities. + -Configuration +CONFIGURATION ------------- -The configuration for Flag is spread between Views configuration -and the Flag site building page. To configure: + +The configuration for Flag is spread between Views configuration and the Flag +site building page. To configure: 1) Configure the flags for your site at Administer -> Structure -> Flags (/admin/structure/flags) @@ -84,11 +111,13 @@ and the Flag site building page. To configure: can override the view or use it as a template to control the display of your flags. -Support -------- -If you experience a problem with flag or have a problem, file a -request or issue on the flag queue at -http://drupal.org/project/issues/flag. DO NOT POST IN THE FORUMS. + +MAINTAINERS +----------- + +If you experience a problem with flag or have a problem, file a request or issue +on the flag queue at http://drupal.org/project/issues/flag. DO NOT POST IN THE +FORUMS. Posting in the issue queues is a direct line of communication with the module authors. @@ -99,3 +128,9 @@ software or obligated in any way to correct problems you may experience. Licensed under the GPL 2.0. http://www.gnu.org/licenses/gpl-2.0.txt +Current maintainers: + * Joachim Noreiko (joachim) - https://www.drupal.org/user/107701/ + * Tess (socketwench) - https://www.drupal.org/user/65793 + * Shabana Navas (shabana.navas) - https://www.drupal.org/user/1311398 + * Nate Haug (quicksketch) - https://www.drupal.org/user/35821 + * mooffie - https://www.drupal.org/user/78454