From da17a9460c6878c2a7fdb1afdcb147a375d9fb1a Mon Sep 17 00:00:00 2001
From: Tristan Ferrua <tristanferrua@gmail.com>
Date: Fri, 29 Jan 2021 14:29:05 +0000
Subject: [PATCH] Update README.md

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 96e29a6..26829a3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
-# miniplayer
+# Miniplayer
+
 A curses based mpd client with basic functionality and album art written for the Kitty terminal.
+
+## Configuration
+
+The config file is located at `~/.config/miniplayer/config`. The example configuration file, `config.example`, has all the default values.
+
+* ***music_directory*:** The path to your music directory for extracting album art.
+* ***font_width*:** The width of your font in pixels in the actual terminal.
+* ***font_height*:** The height of your font in pixels in the actual terminal.
+
+## Keybinds
+
+| Key | function      |
+|-----|---------------|
+| h   | Show keybinds |
+| p   | Play/pause    |
+| >   | Next track    |
+| <   | Last track    |
+| q   | Quit          |
+| +   | Volume +5     |
+| -   | Volume -5     |