Revise plugin documentation. Mainly, this removes remains of documentation
[squirrelmail.git] / plugins / newmail / README
index fc6f053..50b46d0 100644 (file)
@@ -1,6 +1,3 @@
-Ok, this is my first attempt at a plugin, so excuse the mess you may find
-in here.
-
 This plugin is used to play sounds (currently a WAV file) through the
 browser whenever the user has unseen messages flagged in the left window
 pane.  There are options available (on the options page of course) to
@@ -9,51 +6,15 @@ from the users local computer.  The default is that this is NOT enabled,
 so you'll need to go to the options menu to turn it on first! There are
 also options to show a popup window via JavaScript.
 
-I tried to make this fairly simple to install.  To install the plugin:
-
-  1.  Change to the plugins directory.
-
-        $ cd plugins/
-
-  2.  Unarchive the plugin.
-
-        $ tar zxvf /your/path/to/newmail-x.x.tgz
-
-  2.  This should create a newmail/ directory under plugins.
-
-  4.  Go to the config directory and run conf.pl
-
-        $ cd ../../config/
-        $ ./conf.pl
-
-  5.  Choose option 8 and proceed to add the new plugin following
-      the instructions there.  Save and exit, and your plugin should
-      be in place.
-
-Any questions, you can let me know --
-
-Mike Huttinger
-huttinger@ipact.com
-
------------------------------------------
-
-Modifications by Tyler Akins to support changing the title bar and for the
-new 1.1.1 validate.php format.  Also uses the new sqimap_unseen_messages()
-function in 1.1.2
-
------------------------------------------
-
-Modification by Wouter Teepe from Seth Randall...
-to disallow the use of audio, change 
-    $allowsound = "true";
-to 
-    $allowsound = "false";
-on line 33 of newmail_opt.php
-
------------------------------------------
-
 From SquirrelMail 1.5.1 newmail plugin's site configuration can be stored in
 config/newmail_config.php or plugins/newmail/config.php.
 
 $allowsound setting is replaced with $newmail_allowsound and should be stored
 inside plugin's site configuration file.
+
+
+CREDITS
+
+This plugin has been originally created by Mike Huttinger, with contributions
+by Tyler Akins and Seth Randall. It's now maintained by the SquirrelMail
+Project Team.