From 4b0ace13acc7d123b238b1a910ed0fe40a391668 Mon Sep 17 00:00:00 2001 From: Thibaut Horel Date: Tue, 16 Apr 2013 23:46:01 +0200 Subject: Restructure the documentation --- README.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.rst (limited to 'README.rst') 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 -- cgit v1.2.3-70-g09d2