update readme (#25)

Author: ovv

README.rst

@@ -4,14 +4,18 @@
 
 |build| |doc|
 
-A bot framework built for the people and by the people of the `python developers slack community`_.
+An asynchronous python bot framework.
 
-The uses of bots are nearly endless and come in all shapes and sizes. They can handle Slack shenanigans, monitor the status of a crypto-currency, or become your personal assistant. sir-bot-a-lot can help you get started writing your own bot.
+The uses of bots are nearly endless and come in all shapes and sizes.
+They can handle Slack shenanigans, monitor the status of a crypto-currency,
+or become your personal assistant. Sir-bot-a-lot can help you get started
+writing your own.
 
+Sir-bot-a-lot is a project maintained by the `pyslackers`_ community.
 Want to join? `Get an invite`_ !
 
-.. _Get an invite: http://pythondevelopers.herokuapp.com/
-.. _python developers slack community: https://pythondev.slack.com/
+.. _pyslackers: http://pyslackers.com
+.. _Get an invite: http://pyslackers.com
 .. |build| image:: https://travis-ci.org/pyslackers/sir-bot-a-lot.svg?branch=master
     :alt: Build status
     :target: https://travis-ci.org/pyslackers/sir-bot-a-lot
@@ -23,68 +27,6 @@ Want to join? `Get an invite`_ !
     :alt: Sir-bot-a-lot icon
     :target: http://sir-bot-a-lot.readthedocs.io/en/latest
 
-Installation
-------------
+Documentation available `here`_.
 
-The sources for sir-bot-a-lot can be downloaded from the `github repo`_.
-
-.. code-block:: console
-
-    $ git clone https://github.com/pyslackers/sir-bot-a-lot.git
-
-Once you have a copy of the source, you can install it with:
-
-.. code-block:: console
-
-    $ pip install sir-bot-a-lot/
-
-To install the development requirements do:
-
-.. code-block:: console
-
-    $ pip install sir-bot-a-lot/[dev]
-
-Run
----
-
-To start Sir-bot-a-lot use the command
-
-.. code-block:: console
-
-    $ sirbot
-
-By default no plugins are installed so Sir-bot-a-lot will do nothing.
-Check out the `available plugins`_.
-
-.. _github repo: https://github.com/pyslackers/sir-bot-a-lot
-.. _available plugins: http://sir-bot-a-lot.readthedocs.io/en/latest/plugins.html#available-plugins
-
-Docker
-------
-
-Build the image:
-
-.. code-block:: console
-
-    $ docker build -t sir-bot-a-lot .
-
-And run the image:
-
-.. code-block:: console
-
-    $ docker run -ti -p "8080:8080" sir-bot-a-lot
-
-Configuration
--------------
-
-To load a custom file use the ``--config`` argument or the ``SIRBOT_CONFIG`` environment variable with the configuration file path.
-
-The default configuration file look like this:
-
-.. code-block:: yaml
-
-    sirbot:
-      port: 8080
-      plugins: []
-
-Plugins can also be added with the ``--plugins`` argument
+.. _here: http://sir-bot-a-lot.readthedocs.io/en/latest/

docs/configuration.rst

@@ -2,24 +2,31 @@
 Configuration
 =============
 
-Command Line
-------------
+Start
+-----
 
-To start Sir Bot-a-lot you can use:
+To start Sir Bot-a-lot you can use one of:
 
 .. code-block:: console
 
     $ sirbot
 
-or:
-
 .. code-block:: console
 
     $ python run.py
 
 
-Arguments
-^^^^^^^^^
+Environment variables
+---------------------
+
+The environment variable take precedence over the command line arguments.
+
+* :code:`SIRBOT_PORT`: Port where to run Sir Bot-a-lot
+* :code:`SIRBOT_CONFIG`: Path to Sir Bot-a-lot Yaml config file
+
+
+Command line arguments
+----------------------
 
 The command line arguments take precedence over the configuration file.
 
@@ -30,23 +37,11 @@ The command line arguments take precedence over the configuration file.
 * :code:`-p --plugins`: Plugins to start
 
 
-Environment variables
----------------------
-The environment variable take precedence over the command line arguments and the
-configuration file.
-
-* :code:`SIRBOT_PORT`: Port where to run Sir Bot-a-lot
-* :code:`SIRBOT_CONFIG`: Path to Sir Bot-a-lot Yaml config file
-
-
 Configuration file
 ------------------
 
-Sir Bot-a-lot configuration is a Yaml file containing the core and all the additional
-plugins configuration.
-
-The environment variable and command line arguments take precedence over the
-configuration file.
+Sir Bot-a-lot configuration is a Yaml file containing the core and all the
+additional plugins configuration.
 
 A basic configuration will look like this:
 
@@ -63,11 +58,13 @@ A basic configuration will look like this:
 Starting priority
 ^^^^^^^^^^^^^^^^^
 
-Plugins can be dependant on other plugins. You can ensure a startup order by setting a startup priority. By default all plugins have a priority of 50. Plugins with a higher priority will start before the one with a lower priority.
+Plugins can depend on other plugins. You can ensure a startup order by setting
+a startup priority. By default all plugins have a priority of 50. Plugins with
+a higher priority will start before the one with a lower priority.
 
 If multiple plugins have the same priority they will start simultaneously.
 
-The priority can be set to false to disable a plugin.
+A priority of 0 or false will disable the plugin.
 
 .. code-block:: yaml
 

docs/index.rst

@@ -7,7 +7,14 @@
 Welcome to Sir Bot-a-lot's documentation!
 =========================================
 
-An asynchronous bot framework built for the people and by the people of the `python developers slack community`_.
+An asynchronous python bot framework.
+
+The uses of bots are nearly endless and come in all shapes and sizes.
+They can handle Slack shenanigans, monitor the status of a crypto-currency,
+or become your personal assistant. Sir-bot-a-lot can help you get started
+writing your own.
+
+Sir-bot-a-lot is a project maintained by the `pyslackers`_ community.
 Want to join? `Get an invite`_ !
 
 .. toctree::
@@ -24,5 +31,5 @@ Want to join? `Get an invite`_ !
    authors
    license
 
-.. _Get an invite: http://pythondevelopers.herokuapp.com/
-.. _python developers slack community: https://pythondev.slack.com/
+.. _pyslackers: http://pyslackers.com
+.. _Get an invite: http://pyslackers.com

docs/installation.rst

@@ -8,7 +8,9 @@ Installation
 Stable release
 --------------
 
-**NOT YET RELEASED**
+.. note::
+
+    Not yet released
 
 To install sir-bot-a-lot, run this command in your terminal:
 
@@ -30,7 +32,7 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://gitlab.com/PythonDevCommunity/sir-bot-a-lot
+    $ git clone git://github.com/pyslackers/sir-bot-a-lot
 
 Or download the `tarball`_:
 

docs/plugins.rst

@@ -4,7 +4,7 @@
 Plugins
 =======
 
-.. _available_plugins:
+.. _available plugins:
 
 Available plugins
 -----------------
@@ -43,4 +43,6 @@ A new facade instance is created each time a plugin request one.
 Example
 ^^^^^^^
 
-For example plugins take a look at the example folder in the github repository.
+For example plugins take a look at the `example folder`_ in the github repository.
+
+.. _example folder: https://github.com/pyslackers/sir-bot-a-lot/tree/master/examples/plugin