aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e1882fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# beets-plugins
+
+This is a collection of my beets plugins.
+
+## Plugins
+
+- `browse`: Browse items on MusicBrainz or the file system. See `beet help
+ browse`
+- `extras`: Bring along extra files when moving or copying music. Expects a list
+ `paths` in the `extras` configuration with files or directories to bring along.
+
+## Installation
+
+To install these plugins locally, run:
+
+ pip install --user .
+
+Then enable each plugin in the `beets` configuration.