/*======================================================================*\
|| #################################################################### ||
|| # DragonByte Tech - xFShout					      # ||
|| # ---------------------------------------------------------------- # ||
|| # Copyright 2010 DragonByte Technologies 			      # ||
|| # http://www.dragonbyte-tech.com - http://www.dragonbyte-tech.net  # ||
|| # All Rights Reserved.                                             # ||
|| # This file may not be redistributed in whole or significant part. # ||
|| # ---------------------------------------------------------------- # ||
|| #################################################################### ||
\*======================================================================*/

/*======================================================================*\
|| Table of contents                                                    ||
||  1. License                                                          ||
||  2. Requirements                                                     ||
||  3. First Time Installation / Upgrade 	                        ||
||  4. Creating New Instances  						||
||  5. Available Slash Commands						||
\*======================================================================*/


/*======================================================================*\
|| 1. License                                                           ||
\*======================================================================*/

xFShout is released under the All Rights Reserved licence.
You may not redistribute the package in whole or significant part.
All copyright notices must remain unchanged and visible.
You may provide phrase .xml files for other languages on any site,
but you may not provide the full product .xml file - only the phrases.


/*======================================================================*\
|| 2. Requirements                                                      ||
\*======================================================================*/

xFShout has been tested to work on XenForo v1.0.0
It is not guaranteed to work on any other version.


/*======================================================================*\
|| 3. First Time Installation / Upgrade                                 ||
\*======================================================================*/

1. Upload all files from the "upload" folder to your forums directory.

2. Import the addon_dbtech_xf_topxstats.xml file from the "XML" folder at AdminCP -> Home -> Install AddOn / Upgrade Addon.

3. Open template "forum_list" -> find:
---
<xen:if is="{$renderedNodes}"><xen:include template="node_list" /></xen:if>
---

Add Above:
---
<!--XFSHOUT.1-->
---

4. That's it! You can start editing settings.


/*======================================================================*\
||  4. Creating New Instances  						||
\*======================================================================*/

After you've created a new instance, you must note down the "Instance ID".

This is found by hovering over the link in the "Manage Instances" area:
---
	admin.php?xfshout-instances/2/edit
---
This is "Instance ID" 2.


To make this newly created instance show up, edit any template you want
and add
---
<!--XFSHOUT.2-->
---
If "Instance ID" 2 was what you found.

Repeat for each instance you create.


/*======================================================================*\
||  5. Available Slash Commands						||
\*======================================================================*/

/prune
	Removes all shouts in the Shoutbox

/removenotice
/removesticky
/sticky
	Deletes the Sticky Note

/me Text
	Shows *Username Text*

/notice Text
/setnotice Text
/sticky Text
/setsticky Text
	Sets the Sticky Note to Text

/ban Username
	Bans a specified user

/unban Username
	Unbans a specified user
