summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimeon Simeonov2014-07-19 13:58:54 +0200
committerSimeon Simeonov2014-07-19 13:58:54 +0200
commitfa1aacfde8679551cebda346a2c45d04204441eb (patch)
tree6dc0b0c754f8bdeec35db4e4d6aacc07a0897bd1
parenta57a2a77dc5101ca3c62700e7bca4eaf4e25fd5c (diff)
README almost done
-rw-r--r--README23
1 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
index 026c70d..47bd797 100644
--- a/README
+++ b/README
@@ -27,7 +27,30 @@ beinc_generic_client.py - a simple client used to push notification messages
27Why should I use BEINC and what has it done for me lately? 27Why should I use BEINC and what has it done for me lately?
28---------------------------------------------------------- 28----------------------------------------------------------
29 29
30BEINC is designed to assist you two common scenarios.
31As an example we will consider the case of an IRC cliet, although BEINC can be
32used by any client that conforms with BEINC's "messaging protocol".
30 33
34We have the common situation where a user is accessing an IRC client located on
35a different computer (typically: weechat, irssi, etc. running on a remote server)
36The IRC client receives a private message (or any event that requires the user's
37attention) and the user has to be notified.
38
39Scenario one:
40The user's computer can be reached from the server running the IRC client.
41If the server (running the IRC client) is able to connect to
42a specified TCP port on the user's computer, this is sufficient for BEINC to
43directly notify the user. Solution:
44 - set up the beinc_server.py on the desktop workstation (the computer where the
45 notification-message should be displayed). Define an unprivileged port for
46 beinc_server.py to listen on and enable its OSD capabilities
47 (through pynotify and/or pyosd)
48 - set up a BEINC client similar to beinc_generic_client.py on the server
49 If you are running weechat >=0.4.0, this version of BEINC comes with
50 a complete weechat BEINC-client: beinc_weechat.py
51 Configure the client to send notifications to the beinc_server.py
52
53Scenario two:
31 54
32 55
33 56