From 82253cef01b2e7aa8ca2559c4a59f6d3a2f43620 Mon Sep 17 00:00:00 2001
From: ayntgl <ayntgl@gmail.com>
Date: Sat, 2 Oct 2021 18:05:07 +0400
Subject: [PATCH] docs(README): add sample configuration

---
 README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 44 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index a301eca..952a8aa 100644
--- a/README.md
+++ b/README.md
@@ -36,15 +36,54 @@ sudo mv ./discordo /usr/local/bin
 
 ## Usage
 
-- Run the executable in a new Terminal window.
+1. Run the `discordo` executable with no arguments in a new Terminal window.
+2. Log in using the account email and password (first-time login) and click on the "Login" button to continue.
 
-By default, Discordo utilizes OS-specific keyring to store credentials such as client authentication token. However, if you prefer not to use a keyring, you may set the `token` field in the configuration file (`~/.config/discordo/config.json`) and Discordo will prioritize the usage of `token` field to login instead of keyring.
-
-- Log in using the email and password (first-time login) and click on the "Login" button to continue.
+> By default, Discordo utilizes OS-specific keyring to store credentials such as client authentication token. However, if you prefer not to use a keyring, you may set the `token` field in the configuration file (`~/.config/discordo/config.json`) and Discordo will prioritize the usage of `Token` field to login instead of keyring.
 
 ### Configuration
 
-Discordo aims to be highly configurable, it may be easily customized via a configuration file. It creates a default configuration file on the first start-up. The newly created configuration file is located at `$HOME/.config/discordo/config.json`.
+Discordo aims to be highly configurable, it may be easily customized via a configuration file. It creates a default configuration file on the first start-up. The default and newly created configuration file is located at `$HOME/.config/discordo/config.json`. Here is a sample (not default) configuration file:
+
+```json
+{
+  // The client authentication token (optional)
+  "Token": "",
+  // Enables mouse support.
+  "Mouse": true,
+  // Enables OS-specific desktop notifications when the client user is mentioned in non-selected channels.
+  "Notifications": true,
+  // Set a custom user agent for all of the HTTP requests.
+  "UserAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
+  // Set the number of messages to retrieve when a text-based channel is selected.
+  "GetMessagesLimit": 30,
+  // The Theme field values can be hex color codes (#f44f36) or W3C color names.
+  "Theme": {
+    "PrimitiveBackgroundColor": "black",
+    "ContrastBackgroundColor": "blue",
+    "MoreContrastBackgroundColor": "green",
+    "BorderColor": "white",
+    "TitleColor": "white",
+    "GraphicsColor": "white",
+    "PrimaryTextColor": "white",
+    "SecondaryTextColor": "yellow",
+    "TertiaryTextColor": "green",
+    "InverseTextColor": "blue",
+    "ContrastSecondaryTextColor": "darkcyan"
+  },
+  "Keybindings": {
+    "GuildsTreeViewFocus": "Alt+Rune[1]",
+    "MessagesTextViewFocus": "Alt+Rune[2]",
+    "MessagesTextViewSelectPrevious": "Up",
+    "MessagesTextViewSelectNext": "Down",
+    "MessagesTextViewSelectFirst": "Home",
+    "MessagesTextViewSelectLast": "End",
+    "MessagesTextViewReplySelected": "Rune[r]",
+    "MessagesTextViewMentionReplySelected": "Rune[R]",
+    "MessageInputFieldFocus": "Alt+Rune[3]"
+  }
+}
+```
 
 ### Clipboard support