Added a description for the readme #24

pull/28/head
tijder 6 years ago committed by GitHub
parent 3dcabe2114
commit 736ea67524
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,5 +1,8 @@
# SmsMatrix
A simple SMS (text message) <--> Matrix bridge.
A simple SMS (text message) <--> Matrix bridge.
This app bridges all sms messages to matrix. For every (new) text conversation contact the bot will open a private 1:1 room and sends the incoming messages to that room. Any messages sent in that room by the matrix user will then be sent to the contact via SMS.
As currently there is no end-to-end encryption implemented in this app, for privacy reasons it is preferable to use it with your own Matrix server. Your data-in-transit however will always be safe as they are encrypted using https over matrix -- provided the Matrix server is configured properly.
# Set up
- Create a acount on a homeserver
@ -12,4 +15,4 @@ A simple SMS (text message) <--> Matrix bridge.
- Your username: is where you want to forward all yous text message to
- Devicename: is the devicename wich the api will use
- Press save
- Now all your text messages will be bridged
- Now all your text messages will be bridged

Loading…
Cancel
Save