From e0d512ea9b34414c9fc20822e6f4a3d962c1aae8 Mon Sep 17 00:00:00 2001
From: Julian Lobbes <julian.lobbes@protonmail.com>
Date: Mon, 5 Sep 2022 00:23:35 +0200
Subject: [PATCH] docs: add `README` explaining the basics

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..db9e623
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Docker beets
+
+Container used to run the [beets](https://beets.readthedocs.io/en/stable/index.html) music library organizer.
+
+## Quickstart
+
+Copy `config.yaml` into the host volume's `config` folder (in this case `/srv/beets/config`).
+Place the music you want to import into the `import` folder (in this case `/srv/beets/import`).
+Run the beets importer interactively:
+
+```bash
+sudo docker exec -it beets beet import /import
+```
+
+The commandline and/or configuration reference [can be found here](https://beets.readthedocs.io/en/stable/index.html).