Corrected readme and added docs

kc9jud · Sep 1, 2016 · e8b245e · e8b245e
1 parent a707969
commit e8b245e
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -262,7 +262,6 @@ Backends ToDo
 -  `Airgram <http://www.airgramapp.com>`_
 -  `Pushalot <https://pushalot.com>`_
 -  `Boxcar <https://boxcar.io>`_
--  `Instapush <https://instapush.im>`_
 
 Testing
 -------

diff --git a/docs/ntfy.backends.rst b/docs/ntfy.backends.rst
@@ -60,6 +60,15 @@ ntfy.backends.notifico module
     :undoc-members:
     :show-inheritance:
 
+ntfy.backends.insta module
+-----------------------------
+
+.. automodule:: ntfy.backends.insta
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
 ntfy.backends.win32 module
 --------------------------
 

diff --git a/ntfy/backends/insta.py b/ntfy/backends/insta.py
@@ -8,6 +8,13 @@ class ApiException(Exception):
     pass
 
 def notify(title, message, event_name, appid, secret, trackers, retcode=None):
+    """
+    Required parameter:
+        * ``event_name`` - Instapush event (the notification template)
+        * ``appid`` - The appid found on the dashboard
+        * ``secret`` - The secret found on the dashboard
+        * ``traskers`` - List of the placeholders for the selected event
+    """
     logger = logging.getLogger(__name__)
     msgs = message.split(":")