Create README.md

pbalash0v · Mar 22, 2023 · 10737a7 · 10737a7
1 parent 113b3bd
commit 10737a7
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# cliph
+Dead-simple CLI SIP client (for experimental purposes mainly)
+
+Presumably could be built on *NIX systems. At the moment only outgoing calling supported, only OPUS codec. Incoming audio quality may be low as no playout buffer is implemented atm.
+
+Build using usual CMake routine. Find built binary in build folder in `out/bin` subfolder.
+
+Simple usage:
+```shell
+./out/bin/cliph -u=sip:[email protected] -d=sip:[email protected] -o=sip:proxy.domain.com -a=<auth_user_name> -p=<auth_password>
+```