From bf5e99aeba0db77d280c97a956763a9163ec31e9 Mon Sep 17 00:00:00 2001
From: Wolfgang Müller
Date: Sun, 10 Mar 2024 15:29:06 +0100
Subject: Initial commit

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53c3ee0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# bass
+
+A minimal wrapper around `mpc` and `beets` for the
+[fish](https://fishshell.com/) shell.
+
+[ListenBrainz](https://listenbrainz.org) integration requires
+[listenbrainz-mpd](https://codeberg.org/elomatreb/listenbrainz-mpd).
+
+## Installation
+
+Merge both `functions/` and `completions/` into your `~/.config/fish/` or
+`$XDG_CONFIG_HOME/fish/` directory.
+
+## Usage
+
+- `bass` will accept any command that `mpc` accepts. If no command is given, the playlist is printed.
+- `bass id` prints the MusicBrainz ID of the currently playing track.
+- `bass browse` opens the currently playing track on [MusicBrainz](https://musicbrainz.org/).
+- `bass love` marks the currently playing track as loved on ListenBrainz.
+- `bass hate` marks the currently playing track as hated on ListenBrainz.
-- 
cgit v1.2.3-2-gb3c3