From cc7f6404f202bbbf8622ecda1b1ef16e04234dfd Mon Sep 17 00:00:00 2001
From: Mackenzie Frew <11793063+frewmack@users.noreply.github.com>
Date: Fri, 9 Feb 2024 20:10:31 -0500
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7300359
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Bar+ Bulk Search
+
+A simple CLI app for bulk-searching [Bar+ Karaoke](https://bar-plus.com/song/index) for songs by artist/title.
+
+## How to use
+
+You need a CSV file containing song Artists and Titles. Make sure there is a header line. eg.
+
+```csv
+Artist,Title
+Toto,Africa
+Weezer,Buddy Holly
+```
+
+Run `./search.exe <csv_path>` in your terminal to search songs by artist. 
+Add `--strict` to search songs only by title, which is faster but will yield fewer songs.
+
+### Spotify
+
+Create a playlist on Spotify that you would like to search with. If you want to search your Liked Songs, 
+you need to `CTRL-A` your Liked Songs and add them to a playlist.
+
+Go to https://www.spotlistr.com/export/spotify-playlist and provide a Playlist URL.
+Make sure that **Artist(s) Name** and **Track Name** are the **only** fields selected, and that
+`,` is the Separator. Then, download as CSV and place it in the same directory as `search.exe`.
+
+## Development
+
+You need Python 3.10 or greater.
+
+Create a virtual environment and install requirements:
+
+```
+python -m venv ./venv
+pip install -r requirements.txt
+```