aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorThibaut Horel <thibaut.horel@gmail.com>2013-04-16 23:46:01 +0200
committerThibaut Horel <thibaut.horel@gmail.com>2013-04-16 23:46:01 +0200
commit4b0ace13acc7d123b238b1a910ed0fe40a391668 (patch)
tree4da66ec20545beaf39bf9c4b9b5cfd807b08bd50 /README.rst
parent7adcac4cf9e86fed4aa9f91631544d7e5bce48a7 (diff)
downloadpython-pushover-4b0ace13acc7d123b238b1a910ed0fe40a391668.tar.gz
Restructure the documentation
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..44eff08
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,29 @@
+Python-pushover aims at being a comprehensive Python API implementation of the
+`Pushover Notification Service`_ as documented here__.
+
+.. _Pushover Notification Service: https://pushover.net/
+.. __: https://pushover.net/api
+
+Installation
+------------
+
+You can install python-pushover directly from Pypi_ with ``pip install
+python-pushover`` or ``easy_install python-pushover``.
+
+Or you can install it directly from GitHub_:
+
+.. code-block:: bash
+
+ git clone https://github.com/Thibauth/python-pushover.git
+ cd python-pushover
+ python setup.py install
+
+.. _Pypi: https://pypi.python.org/pypi/python-pushover/
+.. _GitHub: https://github.com/Thibauth/python-pushover
+
+Documentation
+-------------
+
+You can access the full documentation here__.
+
+.. __: http://pythonhosted.org/python-pushover