summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README10
1 files changed, 6 insertions, 4 deletions
diff --git a/README b/README
index f3e241e..f15f736 100644
--- a/README
+++ b/README
@@ -6,8 +6,8 @@ What is BEINC?
6-------------- 6--------------
7 7
8Blackmore's Enchanced IRC Notification Collection (BEINC) is a free set of 8Blackmore's Enchanced IRC Notification Collection (BEINC) is a free set of
9components that aim to provide a complete system for different on-screen-display 9components that aims to provide a complete system for different
10notification scenarios. 10on-screen-display notification scenarios.
11 11
12The current version of BEINC contains the following components: 12The current version of BEINC contains the following components:
13beinc_server.py - server used for queueing or providing on-screen-display (OSD) 13beinc_server.py - server used for queueing or providing on-screen-display (OSD)
@@ -19,7 +19,7 @@ beinc_generic_client.py - a simple client used to push notification messages
19 to beinc_server.py 19 to beinc_server.py
20 Its main purpose is to provide a convenient way to 20 Its main purpose is to provide a convenient way to
21 test beinc_server.py (and beinc_poller.py) as well as 21 test beinc_server.py (and beinc_poller.py) as well as
22 to serve as an example on how to develop BEINC-clients 22 to serve as an example for how to develop BEINC-clients
23+ documentation and a sample configuration file (beinc_config_sample.json) 23+ documentation and a sample configuration file (beinc_config_sample.json)
24 24
25 25
@@ -93,7 +93,9 @@ All components tested on: Gentoo GNU/Linux 2014,2015,
93 93
94 94
95Requirements: 95Requirements:
96All components: Python 2.7.* (for TLS1.1 and TLS1.2 client support you ned Python>=2.7.9) 96All components: Python 2.7.*
97N.B. For TLS1.1 and TLS1.2 client support you need Python>=2.7.9
98
97beinc_server.py: Twisted Web >= 14.0, pyopenssl >= 0.13.0, 99beinc_server.py: Twisted Web >= 14.0, pyopenssl >= 0.13.0,
98 pynotify >= 0.1 (optional), pyosd >= 0.2 (optional) 100 pynotify >= 0.1 (optional), pyosd >= 0.2 (optional)
99beinc_weechat.py: Weechat >= 0.4.0 101beinc_weechat.py: Weechat >= 0.4.0