From: Tobias Diekershoff <tobias.diekershoff@gmx.net>
Date: Tue, 7 Jul 2015 15:30:39 +0000 (+0200)
Subject: added README file for the IRC addon
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=da5363b00a76f203028613ecf7be65301771c6da;p=friendica-addons.git

added README file for the IRC addon
---

diff --git a/irc/README.md b/irc/README.md
new file mode 100644
index 00000000..87d65952
--- /dev/null
+++ b/irc/README.md
@@ -0,0 +1,14 @@
+IRC App
+=======
+
+This addon will add an app to your page which will allow your users to access
+the [IRC](https://en.wikipedia.org/wiki/IRC) at [freenode.net](https://freenode.net) via a webinterface from your node. The chat interface
+will be loaded in an iframe from webchat.freenode.net.
+
+You can specify two sets of channel lists.
+
+1. a list of channels the interface shall automatically connect to
+2. a list of popular channels which will be displayed aside the chat interface.
+   the channels in this list will be linked so your users can easily join them.
+
+If you don't specify a list of popular channels, the following will be shown: friendica, chat, chatback, hottub, ircbar, dateroom, debian