From 79919854239df74a08dce1a70951d0ebbebee960 Mon Sep 17 00:00:00 2001
From: aditya-K2 <adityakurdunkar2@gmail.com>
Date: Fri, 12 Nov 2021 14:58:05 +0530
Subject: [PATCH] UPDATE README

---
 README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 54 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0a18b5b..7c8538f 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ https://user-images.githubusercontent.com/51816057/140478368-5b724b2f-2499-4150-
 - [ ] Visual Mode (like vim) for updating playlists
 - [ ] Music Visualizer
 
-# Prerequisites
+# Setting Up
 
 - Music Player Daemon must be setup
 - Go Should Be Installed ( for building )
@@ -30,6 +30,59 @@ cd goMP &&
 go build
 ```
 
+# Configuration
+
+## Key Mappings
+
+Following Keys can be used for Mappings
+
+| Keys            | Using them in Config  |
+|-----------------|-----------------------|
+| a-z             | a-z                   |
+| A-Z             | A-z                   |
+| {,},(,),[,],<,> | {,},(,),[,],<,>       |
+| Enter(Return)   | ENTER/RETURN          |
+| Tab             | TAB                   |
+| Space           | SPACE                 |
+
+See config/kMap.go for more information
+
+For mapping a key to some function use the following format:
+
+
+```yml
+Function: [ firstMapping, secondMapping, thirdMapping]
+```
+for.eg
+
+
+```yml
+togglePlayBack : [ "p", "T" ] # using the quotes is neccessary.
+```
+
+Following functions are provided :
+
+|          Functions                 |
+|------------------------------------|
+|    "showChildrenContent",          |
+|    "togglePlayBack",               |
+|    "showParentContent",            |
+|    "nextSong",                     |
+|    "clearPlaylist",                |
+|    "previousSong",                 |
+|    "addToPlaylist",                |
+|    "toggleRandom",                 |
+|    "toggleRepeat",                 |
+|    "decreaseVolume",               |
+|    "increaseVolume",               |
+|    "navigateToFiles",              |
+|    "navigateToPlaylist",           |
+|    "navigateToMostPlayed",         |
+|    "quit",                         |
+|    "stop",                         |
+|    "updateDB",                     |
+|    "deleteSongFromPlaylist",       |
+
 ### Tested on following terminals:
 
 - Alacritty