aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorThibaut Horel <thibaut.horel@gmail.com>2014-08-16 19:55:02 -0400
committerThibaut Horel <thibaut.horel@gmail.com>2014-08-16 19:55:02 -0400
commit0ed8bc145d61e01ba7b29e887242b1c41d4911fb (patch)
tree3ff734d619be5e45705d9d3146a7c2d1da500953 /README.rst
parent3d24207be6bf78d7449b83983fd360bb57863ac9 (diff)
downloadpython-pushover-0ed8bc145d61e01ba7b29e887242b1c41d4911fb.tar.gz
Better help
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 98aa1f4..24f7075 100644
--- a/README.rst
+++ b/README.rst
@@ -85,7 +85,16 @@ You can have additional sections and specify a device as well:
``python-pushover`` will attempt to read the configuration from
``~/.pushoverrc`` by default. The section to read can be specified by using the
-``profile`` argument.
+``profile`` argument. With the configuration file above, you can send a message
+by simply doing:
+
+.. code-block:: python
+
+ from pushover import Client
+
+ client = Client().send_message("Hello!", title="Hello")
+
+or ``pushover --title "Hello" "Hello!"`` from the command line.
API
---