diff --git a/LICENSE.md b/LICENSE similarity index 100% rename from LICENSE.md rename to LICENSE diff --git a/README.md b/README.md new file mode 100644 index 0000000..3198242 --- /dev/null +++ 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