diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d6755a --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +pysignald +======= + +[](https://gitlab.com/stavros/pysignald/commits/master) + +pysignald is a Python client for the excellent [signald](https://git.callpipe.com/finn/signald) project, which in turn +is a command-line client for the Signal messaging service. + +pysignald allows you to programmatically send and receive messages to Signal. + +Installation +------------ + +You can install pysignald with pip: + +``` +$ pip install signald +``` + + +Running +------- + +Just make sure you have signald installed. Here's an example of how to use pysignald: + + +```python +from signald import Signal + +s = Signal("+1234567890") +s.send_message("+1098765432", "Hello there!") + +for message in s.receive_messages(): + print(message) +``` |