From 8f4ae5b5efde42a3f651481889cb8c035801712a Mon Sep 17 00:00:00 2001
From: Brad Pitcher <bradpitcher@gmail.com>
Date: Tue, 6 Oct 2015 16:24:08 -0700
Subject: [PATCH] improve docs, add badge

---
 README.rst             | 3 +++
 docs/misfit.rst        | 5 +++++
 misfit/notification.py | 4 ++++
 3 files changed, 12 insertions(+)

diff --git a/README.rst b/README.rst
index f9fd9a4..c5116f6 100644
--- a/README.rst
+++ b/README.rst
@@ -10,6 +10,9 @@ python-misfit
 .. image:: https://requires.io/github/orcasgit/python-misfit/requirements.svg?branch=master
    :target: https://requires.io/github/orcasgit/python-misfit/requirements/?branch=master
    :alt: Requirements Status
+.. image:: https://readthedocs.org/projects/python-misfit/badge/?version=latest
+   :target: http://python-misfit.readthedocs.org/en/latest/?badge=latest
+   :alt: Documentation Status
 
 Misfit API Python Client Implementation
 
diff --git a/docs/misfit.rst b/docs/misfit.rst
index 977c63d..852b2a1 100644
--- a/docs/misfit.rst
+++ b/docs/misfit.rst
@@ -26,6 +26,11 @@ misfit.cli module
    :end-before: """
 .. autoclass:: misfit.cli.MisfitCli
 
+misfit.notification module
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: misfit.notification
+
 misfit.exceptions module
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/misfit/notification.py b/misfit/notification.py
index 42ffd8a..53981f3 100644
--- a/misfit/notification.py
+++ b/misfit/notification.py
@@ -22,6 +22,10 @@ def string_to_sign(data):
 
 
 class MisfitMessage(MisfitObject):
+    """
+    DELETED, CREATED and UPDATED are the three known actions you will find in
+    the ``action`` property
+    """
     DELETED = 'deleted'
     CREATED = 'created'
     UPDATED = 'updated'