Explorar o código

docs(README): add default keybindings heading

rigormorrtiss %!s(int64=4) %!d(string=hai) anos
pai
achega
b79523aed1
Modificáronse 1 ficheiros con 19 adicións e 5 borrados
  1. 19 5
      README.md

+ 19 - 5
README.md

@@ -1,13 +1,18 @@
 # discordo
 
-Lightweight Discord terminal client
+[WIP] Discordo is a terminal-based Discord client that aims to be lightweight, secure, and feature-rich.
 
 ![Preview](assets/preview.png)
 
 ## Features
 
-- **Lightweight**: Discordo is designed to have a low memory footprint and low CPU usage, overall a low usage of system resources.
-- **Secure**: Discordo securely encrypts and stores the authentication token on first login to an OS-specific [keyring](https://en.wikipedia.org/wiki/Keyring_(cryptography)).
+- Lightweight
+- Easy-to-use
+- Secure
+- Cross-platform
+- Configurable
+- Discord-flavored markdown
+- Clipboard support
 
 ## Installation
 
@@ -17,8 +22,8 @@ Lightweight Discord terminal client
 git clone https://github.com/rigormorrtiss/discordo
 cd discordo && go build
 
-# Optional
-mv ./discordo /usr/local/bin
+# optional
+sudo mv ./discordo /usr/local/bin
 ```
 
 ## Getting Started
@@ -27,6 +32,15 @@ mv ./discordo /usr/local/bin
 - Choose the preferred login method.
 - Log in using the chosen login method and click on "Login" button to continue.
 
+### Default Keybindings
+
+| **Shortcut** | **Action**                                |
+|:------------:|:-----------------------------------------:|
+| Ctrl + G     | Sets the focus on the guilds dropdown.    |
+| Ctrl + J     | Sets the focus on the channels treeview.  |
+| Ctrl + K     | Sets the focus on the messages textview.  |
+| Ctrl + L     | Sets the focus on the message inputfield. |
+
 ## Disclaimer
 
 Automated user accounts or "self-bots" are against Discord's Terms of Service. I am not responsible for any loss caused by using "self-bots" or Discordo.