docs: add readme

2026-01-02 12:46:35 +05:30
parent 2ba4663c51
commit c20c45b87a
1 changed files with 21 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,21 @@
+# Beluga
+
+Sync video playback on Linux desktops with `mpv`.
+
+## Server
+
+Deploy it on a server which acts as a broker.
+
+```sh
+go install github.com/lavafroth/beluga/cmd/server@latest
+nohup server &
+disown -a
+```
+
+## Client
+
+```sh
+go install github.com/lavafroth/beluga/cmd/client@latest
+cd directory-with-movie
+client server-hostname-or-ip:8000
+```