aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorterminaldweller <devi@terminaldweller.com>2024-04-28 13:35:24 +0000
committerterminaldweller <devi@terminaldweller.com>2024-04-28 13:35:24 +0000
commiteb12598123dacce9345b3985eff43ec525c1b38d (patch)
treeb7fe123fe921cbde46d764d67b085ccc1ba7f669 /README.md
parentadded basic http auth (diff)
downloadsms-webhook-eb12598123dacce9345b3985eff43ec525c1b38d.tar.gz
sms-webhook-eb12598123dacce9345b3985eff43ec525c1b38d.zip
updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2d4774d..891d6a3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,11 @@
# sms-webhook
-sms webhook
+
+A simple sms webhook with plain authentication to get the SMS you receive on your android phone on IRC.</br>
+I have a made blogpost about it [here](https://blog.terminaldweller.com/posts/how_to_get_your_sms_on_irc).</br>
+
+For IRC bot supports SASL plain authentication.</br>
+The webhook endpoint itself supports HTTP basic authentication.</br>
+The webhook has [pocketbase](https://github.com/pocketbase/pocketbase) integrated so you can use that to create new users.</br>
+
+Last but not least, you will need a forwarding agent that actually sends the SMS you get on your android device to the webhook endpoint.</br>
+Currently [this](https://github.com/bogkonstantin/android_income_sms_gateway_webhook) is what I'm using to forwars my SMS to the webhook. Also make sure the app settings on android are changed accordingly because the forwarder needs to run in the background so make sure android does not battery-optimize it out of existence.</br>