diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
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. |