added comments and link to documentation to irc.php

diff --git a/irc/irc.php b/irc/irc.php
index cf86a446e7626e848762e207386b49ce2473aefa..1e05195099fa03172726bff3f6b9ba7ebe30aa38 100644 (file)
--- a/irc/irc.php
+++ b/irc/irc.php
@@ -6,6 +6,11 @@
 * Author: tony baldwin <https://free-haven.org/profile/tony>
 */
 
+/* enable in admin->plugins
+ * you will then have "irc chatroom" listed at yoursite/apps
+ * and the app will run at yoursite/irc
+ * documentation at http://tonybaldwin.me/hax/doku.php?id=friendica:irc
+ */
 
 function irc_install() {
 register_hook('app_menu', 'addon/irc/irc.php', 'irc_app_menu');
@@ -32,10 +37,13 @@ $baseurl = $a->get_baseurl() . '/addon/irc';
 $o = '';
 
 
- // add the chatroom frame and some html
+/* add the chatroom frame and some html
+ * by altering the "channels=friendica" part of the URL, you can add/remove channels.  
+ * At free-haven.org, I have "?channels=friendica,free-haven", for instance, to open #friendica and #free-haven
+ */
   $o .= <<< EOT
 <h2>IRC chat</h2>
-<p><a href="http://tldp.org/HOWTO/IRC/beginners.html" target="_blank">a beginner's guid to using IRC.</a></p>
+<p><a href="http://tldp.org/HOWTO/IRC/beginners.html" target="_blank">a beginner's guide to using IRC.</a></p>
 <iframe src="http://webchat.freenode.net?channels=friendica" width="600" height="600"></iframe>
 EOT;