badges

docs/conf.py

@@ -113,7 +113,13 @@
 # documentation.
 html_theme_options = {
     'github_user': 'jesseops',
-    'github_repo': 'yact'
+    'github_repo': 'yact',
+    'description': 'A Pythonic approach to handling configuration',
+    'github_banner': True,
+    'codecov_button': True,
+    'travis_button': True,
+    'analytics_id': 'UA-86427924-1',
+
 }
 
 

docs/index.rst

@@ -22,6 +22,7 @@ search for config files, or any of that nonsense. Even better, YACT can
 automatically reload your configuration file when it detects the file has
 changed.
 
+    >>> config = yact.from_file('my-config.yaml', auto_reload=True)
 
 YACT is tested against Python 2.7 & 3.3-3.5.
 

readme.rst

@@ -9,6 +9,10 @@ Simple configuration handling for Python applications.
 .. image :: https://coveralls.io/repos/github/jesseops/yact/badge.svg?branch=master
     :target: https://coveralls.io/github/jesseops/yact?branch=master
 
+.. image:: https://badges.gitter.im/yact-py/Lobby.svg
+   :alt: Join the chat at https://gitter.im/yact-py/Lobby
+   :target: https://gitter.im/yact-py/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
 YACT is a simple, lightweight, and flexible configuration package for Python applications.
 It's designed to be as easy as possible to setup configuration for your project without needing to
 jump through hoops.
@@ -43,6 +47,3 @@ Examples
     >>> True
 
 
-.. image:: https://badges.gitter.im/yact-py/Lobby.svg
-   :alt: Join the chat at https://gitter.im/yact-py/Lobby
-   :target: https://gitter.im/yact-py/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge