sip-bridge-mx

commit 7b7f82826629768c94ec1b39dc14beae60cbd1c0
parent 6daad85725b212706887b3cb82b9c1960af1cd1a
Author: MTRNord <mtrnord1@gmail.com>
Date:   Sat, 19 Aug 2023 20:52:36 +0200

Add readme

Diffstat:
A
README.md
 | 
35
+++++++++++++++++++++++++++++++++++

1 file changed, 35 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+# Matrix SIP Bridge
+
+An attempt to allow dial-in and dial-out using SIP PBX systems with webrtc support for matrix clients.
+
+## Requirements
+
+* A Matrix homeserver
+* A SIP PBX system like Asterisk with webrtc+ws support
+* A Matrix client that supports voice calls
+* Rust
+
+## Installation
+
+```bash
+cargo install --git https://github.com/MTRNord/sip-bridge-mx.git
+```
+
+## Usage
+
+```bash
+Usage: sip_bridge <HOMESERVER_URL> <USERNAME> <PASSWORD> <SIP_SERVER_DOMAIN> <SIP_SERVER_ADDRESS> <SIP_USERNAME> <SIP_PASSWORD>
+
+Arguments:
+  <HOMESERVER_URL>      
+  <USERNAME>            
+  <PASSWORD>            
+  <SIP_SERVER_DOMAIN>   
+  <SIP_SERVER_ADDRESS>  
+  <SIP_USERNAME>        
+  <SIP_PASSWORD>        
+
+Options:
+  -h, --help     Print help
+  -V, --version  Print version
+```