The copyright symbol isn't really needed since the word "copyright" is there. Also...
[squirrelmail.git] / plugins / bug_report / README
index a2f59f2..89cf9e9 100644 (file)
@@ -1,4 +1,4 @@
-Bug Reporter -- Version 1.0
+Bug Reporter Plugin For SquirrelMail
 
 Need to submit a bug?  Need to know valuable system information?  Need
 to be accurate?  This should do it for you.
@@ -35,17 +35,38 @@ Future Work
 Installation
 ============
 
-As with other plugins, just uncompress the archive in the plugins
-directory, go back to the main directory, run configure and add the plugin.
+You must configure this plugin before you enable it in your SquirrelMail
+installation.  The plugin's configuration is stored in one of the
+following files:
 
-Questions/comments/flames/etc can be sent to
-    Tyler Akins <fidian@tiny.net>
+    config/bug_report_config.php
+    plugins/bug_report/config.php files. 
 
+The default configuration options can be found in (copy this file to
+one of the above locations and then edit it to suit you):
 
-Changes
+    plugins/bug_report/config_default.php
+
+If both configuration files are present, this plugin uses the one in
+the config/ directory.
+
+By default, the plugin will only be visible to users listed in the
+following files:
+
+    plugins/bug_report/admins
+    config/admins
+
+... or only to the user that owns the main SquirrelMail configuration
+file.  Other users can use the bug_report plugin if you set a value for
+the administrator's email address in the plugin configuration file and
+set $bug_report_allow_users option to TRUE.
+
+Once the plugin is configured, go back to the main SquirrelMail
+directory, run "configure" and enable the plugin.
+
+
+Credits
 =======
-1.0 -> 1.1
- * Added a bit more data to the report
- * Cleaned up some HTML
- * Altered link in menu bar to look good with other plugins
- * User-selectable list for where message gets sent to
\ No newline at end of file
+
+This plugin has been originally developed by Tyler Akins and is now
+maintained by the SquirrelMail Project Team.