Documentation cleanups. INSTALL -> INSTALL.md, README -> README.md

5 files changed, 30 insertions, 79 deletions

diff --git a/Changelog b/Changelog
index 136fba8..7da19a3 100644
--- a/Changelog
+++ b/Changelog
@@ -1,6 +1,8 @@
 v3.0:
-    - remove TwistedWeb dependency and write the beinc_server.py in pure Python
+    - remove the TwistedWeb dependency and rewrite the beinc_server.py
+      in pure Python
     - implement Python >= 3.4.0 support
+    - remove pyosd support
 
 v2.0:
     - replace charrypy with TwistedWeb as beinc_server.py backend
diff --git a/INSTALL b/INSTALL.md
index f26a6f9..b0e8a0a 100644
--- a/INSTALL
+++ b/INSTALL.md
@@ -1,58 +1,43 @@
-Installation Instructions
--------------------------
+## Installation Instructions
 
 Refer to README for a basic information about the different BEINC components
 and their software requirements!
 
 
-Installing the dependencies
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### Installing the dependencies
 
+#### Gentoo GNU/Linux 2014, 2015
 
-Gentoo GNU/Linux 2014, 2015
-..........................
+# emerge -va dev-python/pyopenssl dev-python/notify-python
 
-# emerge -va dev-python/pyopenssl dev-python/twisted-web dev-python/notify-python dev-python/pyosd 
 
+#### Ubuntu GNU/Linux
 
-Ubuntu GNU/Linux
-................
+# apt-get install python-openssl python-notify2
 
-# apt-get install python-openssl python-twisted-web python-notify2 python-pyosd 
 
-
-FreeBSD 9, 10
-.............
+#### FreeBSD 10, 11
 
 # cd /usr/ports/security/py-openssl
 # make install clean
 
-# cd /usr/ports/www/py-twistedWeb
-# make install clean
-
 # cd /usr/ports/devel/py-notify
 # make install clean
 
-# cd /usr/ports/misc/py-osd
-# make install clean
-
 
-Intallation using virtualenv and pip
-....................................
+#### Intallation using virtualenv and pip
 
 Very often you are not the administrator of the server hosting your BEINC server
 This is where virtualenv may become handy (provided that it has been installed):
 $ virtualenv beinc_installation
 $ cd beinc_installation
 $ source bin/activate
-$ pip install Twisted
 $ pip install pyopenssl
 $ cd beinc-<version>
 $ ./beinc_server.py -h
 
 
-Installing and setting up BEINC
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### Installing and setting up BEINC
 
 Unpack the latest version of BEINC
 $ tar zxvf beinc-<version>.tar.gz
diff --git a/README b/README.md
index f2bf0d5..c6722aa 100644
--- a/README
+++ b/README.md
@@ -2,8 +2,7 @@ Copyright (C) 2014-2018 - Simeon Simeonov
 See the end of the file for license conditions.
 
 
-What is BEINC?
---------------
+## What is BEINC?
 
 Blackmore's Enchanced IRC Notification Collection (BEINC) is a free set of
 components that aims to provide a complete system for different
@@ -23,8 +22,7 @@ beinc_generic_client.py - a simple client used to push notification messages
 + documentation and a sample configuration file (beinc_config_sample.json)
 
 
-Why should I use BEINC and what has it done for me lately?
-----------------------------------------------------------
+## Why should I use BEINC and what has it done for me lately?
 
 BEINC is a free-software, licensed under the GPL3. It gives you the freedoms
 of using it, studying it and modifying it.
@@ -44,7 +42,9 @@ No matter which of the two scenarios applies to your needs, you should start by
    Configure the client to send notifications to the beinc_server.py
 N.B. Using encryption is important in these days and age.
 
-Scenario one: 
+
+### Scenario one
+
 The user's computer can be reached by the server running the IRC client.
 If the server (running the IRC client) is able to connect to 
 a specified TCP port on the user's computer, this is sufficient for BEINC to
@@ -54,10 +54,13 @@ directly notify the user. Solution:
    beinc_server.py to listen on and enable its OSD capabilities 
    (through pynotify)
 
-Scenario two:
+
+### Scenario two
+
 The user's computer can NOT be reached by the server running the IRC client.
 This scenario is typical for users that are working on computers that can not
 be reached from outside.
+
 Solution:
  - find a server that can be reached by the server running the IRC client.
  - set up the beinc_server.py on it. No OSD capabilities are needed (no X11).
@@ -79,20 +82,20 @@ There are 2 operations that can be done on an instance:
  - pull - a poller (f.i. beinc_poller.py) is fetching data from the instance-queue.
           A pull is available only for instances defined for queueing. 
           (read beinc_config_sample.json.readme for details!)
-Example: 
+Example:
 If you defined a beinc_server.py instance with SSL-support,
 your URL will be: https://hostname:port
 
 
-Supported systems & requirements
---------------------------------
+## Supported systems & requirements
+
 Any system running the software required for the selected components.
 All components tested on: Gentoo GNU/Linux 2014,2015,
                           Ubuntu GNU/Linux 14.4,14.10,
                           FreeBSD 10.x
 
 
-Requirements:
+### Requirements
 All components: Python >= 2.7.9 or Python >= 3.4.*
 
 beinc_server.py: pynotify >= 0.1 (optional)
@@ -103,8 +106,7 @@ beinc_generic_client.py: No additional software required
 Read INSTALL in this very same folder for more details about installing the requirements!
 
 
-License
--------
+### License
 
 This file is part of BEINC.
 
diff --git a/beinc_config_sample.json b/beinc_config_sample.json
index 4384555..3b04c0b 100644
--- a/beinc_config_sample.json
+++ b/beinc_config_sample.json
@@ -16,18 +16,6 @@
             {
                 "name": "instance2",
                 "password": "changeme",
-                "osd_system": "pyosd",
-                "osd_timeout": 6,
-                "pyosd_font": "-adobe-courier-bold-o-normal--24-240-75-75-m-150-iso8859-1",
-                "pyosd_vertical_offset": 120,
-                "pyosd_horizontal_offset": 30,
-                "pyosd_align": "left",
-                "pyosd_position": "top",
-                "pyosd_color": "blue"
-            },
-            {
-                "name": "instance3",
-                "password": "changeme",
                 "osd_system": "none",
                 "osd_timeout": 5,
                 "queue_size": 4
diff --git a/beinc_config_sample.json.readme b/beinc_config_sample.json.readme
index edf5845..1bc6b7f 100644
--- a/beinc_config_sample.json.readme
+++ b/beinc_config_sample.json.readme
@@ -30,8 +30,8 @@ documentation to better illustrate the comments.
 
                         # Encryption method for the BEINC server
                         # Possible values:
-                        # "" or "auto" - Let Twisted decide (use the newest possible method)
-                        # "SSLv3" - SSLv3 (weak)
+                        # "" or "auto" - Let the server decide
+            #                (use the newest possible method)
                         # "TLSv1" - TLSv1.0
                         # "TLSv1_1" - TLSv1.1
                         # "TLSv1_2" - TLSv1.2 (most secure, but requires OpenSSL >= 1.0.1e)
@@ -52,37 +52,12 @@ documentation to better illustrate the comments.
                 # Possible values:
                 # "none" - the instance will serve for queueing
                 # "pynotify" - OSD implemented using pynotify (libnotify)
-                # "pyosd" - OSD implemented using pyosd (xosd)                
                 "osd_system": "pynotify",
 
                 # OSD timeout in seconds
                 # The amount of time the OSD message will remain in the screen
                 "osd_timeout": 5,
 
-                # Specify a custom font for the pyosd - backend
-                # "xfontsel" can be used to obtain a list of available fonts
-                "pyosd_font": "",
-
-                # Vertical offset (in pixels) for the pyosd - backend
-                "pyosd_vertical_offset": 120,
-
-                # Horizontal offset (in pixels) for the pyosd - backend
-                "pyosd_horizontal_offset": 30,
-
-                # Text horizontal alignment for the pyosd - backend
-                # Possible values:
-                # "left", "center", "right"
-                "pyosd_align": "left",
-
-                # Text vertical position for the pyosd - backend
-                # Possible values:
-                # "top", "middle", "bottom"                
-                "pyosd_position": "bottom",
-
-                # Font color for the pyosd - backend
-                # See "rgb.txt" in the X11 distribution of a list of colors
-                "pyosd_color": "blue",
-
                 # How many entries to be kept in the queue
                 # (when "osd_system": "none")
                 "queue_size": 4
@@ -123,13 +98,12 @@ documentation to better illustrate the comments.
                                 "ssl_ciphers": "ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384",
 
                                 # Don't check whether the target's hostname matches the server's
-                                # certificate. (Only for Python >= 2.7.9)
+                                # certificate.
                                 # Default: 0
                                 "disable-hostname-check": 0,
 
                                 # Force the client to use a specified SSL/TLS version
-                                # Valid values: "auto", "SSLv3", "TLSv1", "TLSv1_1", "TLSv1_2"
-                                # N.B. "TLSv1_1" and "TLSv1_2" only available in Python >= 2.7.9
+                                # Valid values: "auto", "TLSv1", "TLSv1_1", "TLSv1_2"
                                 # Default: "auto" (Let's OpenSSL select the best option)
                                 "ssl_version": "auto",