From bb955f2546b46e72f7ce30c0aefe88e4a848925b Mon Sep 17 00:00:00 2001
From: Evgeny Zinoviev <me@ch1p.io>
Date: Tue, 23 Mar 2021 04:14:34 +0300
Subject: some improvements while network was down.....

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 25489a0..9d1d166 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,25 @@
 # e3372-py
 
+E3372 SMS handler written in Python. Uses the hilink web interface API. Allows
+you to do something when SMS arrives.
+
 ## Requirements
 
-* lxml (python3-lxml)
+* lxml (`apt install python3-lxml` or something like it)
 * see `requirements.txt`
 
+## Usage
+
+You need at least Python 3.6 or so.
+
+See `main.py` and adjust the `sms_handler` function to your needs.
+
+The script should be launched periodically by cron. This line in crontab would
+launch the script every 10 minutes:
+```cron
+*/10 * * * * python3 /path/to/e3372-py/main.py --trusted-phone 79001234567
+```
+
 ## License
 
 BSD-2c
\ No newline at end of file
-- 
cgit v1.2.3