From b61131caff95d409c5de0180ee7d3917e326ebec Mon Sep 17 00:00:00 2001
From: kageru <kageru@encode.moe>
Date: Sun, 11 Nov 2018 11:28:23 +0100
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c717010
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# rust-mv3u
+A simple rust tool to process playlist renames created by [the beets plugin](https://git.kageru.moe/kageru/beets-mv3u).
+Usage is as follows:
+```sh
+$ mv3u list_of_renames playlist1.m3u playlist2.m3u ...
+```
+where any number of playlists can be passed.
+
+All this does is create a `HashMap<String, String>` and then iterate over all playlist entries, replacing those that are listed in the rename file.