diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.rst | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/doc/index.rst b/doc/index.rst index 96ae17a..5a0dffe 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,9 +1,26 @@ -Home -==== +Python-pushover documentation +============================= -.. toctree:: +.. include:: ../README.rst + :end-line: -7 + +API documentation +----------------- .. automodule:: pushover :members: :undoc-members: :show-inheritance: + + +Command line +------------- + +The module can also be called from the command line for basic message sending. +The minimum invocation is: + +.. code-block:: bash + + python pushover.py --token <app-token> --client <client-id> "Hello!" + + |