Updated README.

This commit is contained in:
Mikkel Munch Mortensen 2015-03-24 20:34:18 +01:00
parent f9f763c3ba
commit 5c06feca02

View file

@ -1,17 +1,24 @@
THIS IS: THIS IS
A Python wrapper around the SMS gateway from CPSMS <https://www.cpsms.dk/>. A Python wrapper around the SMS gateway from CPSMS <https://www.cpsms.dk/>.
THIS IS NOT: THIS IS NOT
Some sort of magic, free SMS gateway. Some sort of magic, free SMS gateway.
INSTALLATION
cpsms is available from PyPI <https://pypi.python.org/pypi/cpsms>.
Easiest way to install is: `pip install cpsms`.
REQUIREMENTS
You need to have a (paid) account at CPSMS to be able to use their gateway. You need to have a (paid) account at CPSMS to be able to use their gateway.
They sell a fair, no-nonsense product which I'd recommend if you want to be They sell a fair, no-nonsense product which I'd recommend if you want to be
able to send SMS from your code (primarily to Danish phones). able to send SMS from your code (primarily to Danish phones).
HOW TO USE
See a couple of example use cases in example.py that should have come See a couple of example use cases in example.py that should have come
along with this file. Apart from what is shown in examples.py, this also along with this file. Apart from what is shown in examples.py, this also
supports status callback URLs, delayed sending and flash messages. supports status callback URLs, delayed sending and flash messages.
FURTHER INFO
For more info on parameters, take a look at the API documentation found at: For more info on parameters, take a look at the API documentation found at:
<https://www.cpsms.dk/login/index.php?page=dokumentation>. <https://www.cpsms.dk/login/index.php?page=dokumentation>.