docs: Added readme

README.md

@@ -0,0 +1,23 @@
+# omegleweb.io bridge for Matrix
+
+Simple bridge to connect your Matrix rooms with omegle.
+
+## Hosting
+
+You should host it using docker-compose.
+
+1. Clone the repository to your server
+2. Copy .env.example to .env and fill in the required variables
+3. Run `docker-compose up -d` to start the bridge
+
+## Usage
+
+1. Go to your Selenium Grid and connect to the VNC, you may need to manually pass the Cloudflare check.
+2. Invite the bot to your Matrix room
+3. Send `!connect` for the bot to connect to omegle websocket
+    If this was done after some time after the bot was started, you may need to connect to the Selenium Grid and pass the Cloudflare check again, as the session may have expired.
+4. Once the bot is connected to omegle, you can run `!match` to start a new match.
+5. Using `!help` you can list all available commands.
+
+## Todo
+- [ ] Better Cloudflare bypass (currently using basic selenium isn't really reliable. If it would be possible to use something like `undetected-chromedriver` it would be nice, but I didn't manage to get it working with Selenium Grid)