Add README

README.md

@@ -0,0 +1,37 @@
+# plexbrainz - scrobble your plex music plays into musicbrainz
+
+## What is this?
+
+This is a self-hosted service which provide a webhook for your plex
+server to hit, uploading each music track's title, artist and album
+to musicbrainz.
+
+It works similarly to https://eavesdrop.fm but is self-hosted, with
+a single binary which weighs in at <30Mb.
+
+## What do I need?
+
+* Docker
+* Your listenbrainz "User Token" (found at https://listenbrainz.org/settings/)
+* Your Plex username (to ensure only your plays are scrobbled)
+* The name(s) of your Plex music libraries
+
+## Setup
+
+* Copy the docker-compose.yml from here to a directory on your 
+  docker host.
+* Change the environment variables to match your account details.
+  * If you have multiple music libraries, you can add them separated
+    by commas, no spaces around the commas.
+* `docker compose up -d`
+* Check logs with `docker compose logs -f`
+
+You can then add the webhook to plex, the config page is at:
+
+    https://app.plex.tv/desktop/#!/settings/webhooks
+
+And the webhook will be something like:
+
+    http://1.2.3.4:9102/plex
+
+Change the IP address to that of your docker host.