added readme

README.md

@@ -0,0 +1,38 @@
+# AppDaemon VSCode Tunnel
+
+## Install Service
+
+Use the `install_service.py` script to install.
+
+- Creates symlinks to `/etc/systemd/system`
+    - `example.socket`
+    - `example.service`
+- Reloads the service definitions
+- Starts the `example.socket`
+- Enables the `example.socket` to start at boot
+
+> [!NOTE]  
+> The `example.socket` does cause `example.service` to start when something connects to the socket at `/run/example.sock`.
+
+> [!CAUTION]
+> `example.service` does not stop when disconnecting from `/run/example.sock`
+
+## Other Commands
+
+Reload systemd units
+
+```shell
+sudo systemctl daemon-reload
+```
+
+List loaded units
+
+```shell
+systemctl list-units --type=service
+```
+
+Check statuses
+
+```shell
+systemctl status example.socket
+```