++++++++++++++++++++++++++++++++++++++++++++++++
Readme for the "Shoutbox Plugin" 
version 0.12
a plugin for pLog (v1.0)
Developed by Palantir, radar@netpalantir.it

See the plugin in action at my blog:
http://www.netpalantir.it

This plugin is released under the terms of the LGPL

++++++++++++++++++++++++++++++++++++++++++++++++
Warning: This is a 0.x version. It may work, but
it may also nuke your blog.  BACK   UP   FIRST!!
++++++++++++++++++++++++++++++++++++++++++++++++

HOW TO INSTALL (from scratch)
1. Unpack the archive
2. Locate the installation directory of your plog
3. Copy the whole "shoutbox" directory into the plugin directory
4. Change the permissions/ownership of all the files, according to your setup.
   If you transfer files via FTP this could be unneccessary. All the files must 
   be readable by the web server.
5. Point your browser to your blog administration page, log in, click on: 
   Control Center > Plugin center. The shoutbox plugin should be on your 
   list. If it is not, try updating the page a few times, it seems to help ;)
6. The first time you run it, the plugin should autodetect if any change has to
   be done to the database and apply them, so to make it ready to use.

HOW TO MAKE IT WORK
First, integrate the plugin into the template.
I am using the grey template, so this example refers to it. The easiest way is
to modify the footer template to add the shoutbox on the right column. Just copy
the enclosed footer.template to <path-to-plog>/templates/grey/footer.template
(remember to back-up your old one!). Also, copy the shoutbox.template to your
templates directory.

HOW TO USE IT
After the first setup, customize the options at the bottom of the page. Then, 
wait for people to leave messages. If you have enabled email notifications, 
you will receive the shouts directly into your mailbox. You can delete shouts 
by selecting them and clicking the delete button.
You can protect one or more nicknames, by adding them into the protected nicks 
box. Separate them using spaces. Then, when you want to use them, simply enter
the nickname followed by : and the password. Password is case sensitive.

HOW TO UPGRADE - Admin Side
Enter the plugins directory, and delete the file called pluginShoutbox.class.php,
then delete the whole directory called pluginShoutbox. Then follow all the steps
in the section HOW TO INSTALL (from scratch)

HOW TO UPGRADE - User Side
Open the template where you have your shoutbox (for example, shoutbox.template
and replace every occurrence of $shoutboxPlugin to $shoutbox

DOESN'T WORK? BUGS? WISHES? WHO TO CONTACT
Please, use the pLog's bug reporting system. It's located at:
http://bugs.plogworld.net

+++++++++++++++++++++++++++++++++++++++++++++++

TODO:
- It would be nice to put the shoutbox into an iframe
- Restore the validation of the fields in the admin interface

+++++++++++++++++++++++++++++++++++++++++++++++

CHANGELOG:

v0.12
- Porting of the whole tinng to the new pLog 1 framework. Costed A LOT of work
so it's not such a _minor_ release ;-)

v0.11x
- Nickname password protection
- Admin section: shout list divided in pages

v0.1
Initial release



