readme

README.md

@@ -0,0 +1,42 @@
+Ever wanted to share your screen for your friends?
+
+Now you can! (Even on Linux and even with application audio!) 🗿🗿🗿🗿
+
+Deploying this shit is as easy as…
+
+…doing this on the server
+
+```bash
+git clone gitea@git.lat:naimi/SSS.git
+cat <<EOF > .env
+BROADCASTER_PASSWORD=usedecentpasswordherelmao
+ANNOUNCED_IP=yourpublicIP
+EOF
+docker compose up -d
+```
+
+…and setting up a minimal nginx server
+
+```nginx
+    location / {
+        proxy_pass http://127.0.0.1:3000;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+    }
+```
+
+On PC:
+
+```bash
+git clone gitea@git.lat:naimi/SSS.git
+cd SSS/client
+npm i
+npm run start
+```
+
+![Client Preview](image.png)