chore: basic readme

bitfocus · Jan 19, 2021 · a6dd780 · a6dd780
1 parent 2835fc9
commit a6dd780
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/LICENSE.md → LICENSE b/LICENSE.md → LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+## Companion Remote
+
+[![License](https://img.shields.io/github/license/julusian/companion-remote)](https://github.com/Julusian/companion-remote/blob/master/LICENSE.md)
+![Version](https://img.shields.io/github/v/release/julusian/companion-remote)
+
+A small application to allow for connecting a streamdeck to [Bitfocus Companion](https://github.com/bitfocus/companion) over a network.
+
+Once running, it will sit in the system tray. Right click it to set the ip address of the companion instance to connect to.
+
+Note: This connects over the satellite device api which uses port TCP 37133.
+
+Companion 2.1.0 and newer are supported