Chore: update readme to reflect changes after rewriting in rust

Author: cbackas

README.md

@@ -1,8 +1,10 @@
 # Hookbuffer
 
-Essentially a webhook proxy server. 
+Essentially a buffering webhook proxy server.
 
-Takes in webhooks that originate from Sonarr and are intended for Discord. It catches "Grabbed" and "imported" notifications from Sonarr, uses some timers to add a delay in which it can catch and group together many notifications by show and season, then pass those groupings along to the intended Discord webhook URL. Sonarr should probably have this built in.... but until then I made this. I don't really expect anyone else to use this, this is my first (and last for a while) Go project and helps solve an annoyance. 
+Takes in webhooks that originate from Sonarr and are intended for Discord. It catches grab, import, and upgrade event notifications from Sonarr, uses some timers to add a delay in which it can catch and group together many notifications by show and season, then pass those groupings along to the intended Discord webhook URL. Sonarr should probably have this built in.... but until then I made this.
+
+Hookbuffer keeps separate queues of messages for each Discord URL it recieves notifications for. This allows 1 Hookbuffer instance to be used for multiple Sonarr instances which go to different destinations without messages getting crossed, which is why I have Hookbuffer deployed to the cloud.
 
 Main benefits:
 - Use Sonarr notifications without as much spam
@@ -11,22 +13,44 @@ Main benefits:
 
 #### Example:
 
-![Example](https://i.imgur.com/GlZTAZc.png)
+![Example](/assets/example_results.png)
 
-Instead of 9 separate Discord messages (one per episode), Hookbuffer groups them by season and sends them to Discord. 
+Instead of 60+ separate Discord messages (one per episode), Hookbuffer groups them by season and sends them to Discord.
 
-### Usage: 
+### Usage:
 
-It's on Dockerhub: https://hub.docker.com/r/cbackas/hookbuffer
+#### Deploying App
 
-```docker run --name hookbuffer -p 5369:5369 cback/hookbuffer:latest```
+Docker image can be found on Github Container Registry: https://github.com/cbackas/hookbuffer/pkgs/container/hookbuffer
 
-Or you can build it and run it using commands
+`docker run --name hookbuffer -p 8000:8000 ghcr.io/cbackas/hookbuffer:latest`
+
+#### Authentication:
+If you deploy this container on the same local network as your Sonarr instance, you don't really need authentication. But if you deploy it to tyhe cloud, you should enable hookbuffer's auth feature. You can add authentication checks by setting the `HOOKBUFFER_USER` and `HOOKBUFFER_PASS` environment variables, ex:
+`docker run --name hookbuffer -p 8000:8000 -e HOOKBUFFER_USER=user -e HOOKBUFFER_PASS=pass ghcr.io/cbackas/hookbuffer:latest`
+
+#### Other Env vars:
+- `HOOKBUFFER_PORT` - Port to listen on inside container (default 8000)
+- `HOOKBUFFER_DESTINATION_URL` - The URL used to send the grouped webhooks to. Defaults to `https://discordapp.com/`
 
-```go build cmd/hookbuffer```
+#### Configuring Sonarr
+First you need to create a Discord webhook in the Discord channel you want to send notifications to. You can do this by going to the channel settings, then "Integrations" and "Webhooks". Create a webhook and copy the URL. More here: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
 
-```./hookbuffer```
+Next we need to configure Sonarr to send notifications through Hookbuffer.
+1. Go to Sonarr -> Settings -> Connect
+2. Create new connection, choose "Webhook" as the connection type
+3. Give the connection a name and *enable the "On Grab", "On Import", and "On Upgrade" triggers*
+4. Configure Webhook URL
+	a. Paste your Discord webhook URL into the "Webhook URL" field
+    b. Replace the "https://discordapp.com/" part of the URL with 'http://\<hookbuffer_host_ip\>:\<hookbuffer_port\>' (example: https://discordapp.com/api/webhooks/12345678910/abcdefghijklmnopqrstuvwxyz -> http://192.168.0.30:8000/api/webhooks/12345678910/abcdefghijklmnopqrstuvwxyz)
+5. Optional: If you configured the `HOOKBUFFER_USER` and `HOOKBUFFER_PASS` env variables, then you can put those values into the "Username" and "Password" fields
+6. Test and Save the connection
 
-Then in Sonarr, go to "Connections" and set up a Discord connection, get a webhook URL from your Discord client, paste that URL and replace https://discordapp.com/ with http://\<host ip\>:5369/ (retaining /api/webhooks/ and everything after it) (Example: https://i.imgur.com/RvZUMOk.png)
+![Sonarr Config Example](/assets/example_sonarr_config.png)
+
+### Build it yourself:
+
+Or you can build it and run it using commands
 
-Currently has no support for passing through the username or avatar fields, as I have those configured directly on my webhooks in Discord.
+Build and run: `cargo run`
+Build Executable: `cargo build --release`