Doc prettiness

Add some badges on the sphinx docs and installation instructions on the
README.

Author: bd808

README.rst

@@ -4,8 +4,8 @@ IRC Bot Behavior Bundle (IB3)
 
 IRC bot framework using mixins to provide commonly desired functionality.
 
-About
-=====
+Overview
+========
 The `irc`_ python library's ``irc.bot.SingleServerIRCBot`` provides a nice
 base for making a new bot, but there are many common tasks needed by a robust
 bot that it does not handle out of the box. IB3 collects some commonly desired
@@ -20,6 +20,11 @@ inheritance`_::
     class TestBot(SASL, SSL, DisconnectOnError, Bot):
         pass
 
+Installation
+============
+* ``pip install ib3`` (recommended)
+* ``python setup.py install`` (from source distribution)
+
 License
 =======
 IB3 is licensed under the `GNU GPLv3+`_ license.

doc/conf.py

@@ -44,3 +44,5 @@
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_static_path = ['_static']
+
+suppress_warnings = ['image.nonlocal_uri']

doc/index.rst

@@ -1,6 +1,23 @@
 IRC Bot Behavior Bundle (IB3) Documentation
 ===========================================
 
+IRC bot framework using mixins to provide commonly desired functionality.
+
+.. image:: https://img.shields.io/pypi/v/ib3.svg
+   :target: https://pypi.org/project/ib3
+
+.. image:: https://img.shields.io/travis/bd808/python-ib3/master.svg
+   :target: http://travis-ci.org/bd808/python-ib3
+
+.. image:: https://readthedocs.org/projects/python-ib3/badge/?version=latest
+   :target: https://python-ib3.readthedocs.io
+
+.. image:: https://img.shields.io/pypi/l/ib3.svg
+   :target: https://github.com/bd808/python-ib3/blob/master/COPYING
+
+.. image:: https://img.shields.io/github/forks/bd808/python-ib3.svg?style=social&label=Fork
+   :target: https://github.com/bd808/python-ib3
+
 .. toctree::
    :maxdepth: 2
 

setup.py

@@ -26,6 +26,7 @@
     author='Bryan Davis',
     author_email='bd808@bd808.com',
     url='https://github.com/bd808/python-ib3',
+    download_url='https://pypi.python.org/pypi/ib3',
     packages=setuptools.find_packages(
         exclude=['docs', 'tests', 'tests.*']),
     include_package_data=True,