docs: add README.md (#298)
Co-authored-by: ayn2op <119342035+ayn2op@users.noreply.github.com>
This commit is contained in:
Matthieu LAURENT
GitHub
parent
e058d74991
commit
273c9cddbe
3 changed files with 80 additions and 65 deletions
80
docs/README.md
Normal file
80
docs/README.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
# Discordo
|
||||
|
||||
Discordo is a lightweight, secure, and feature-rich Discord terminal client.
|
||||
|
||||
## Warning
|
||||
|
||||
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.
|
||||
|
||||
## Authentification
|
||||
|
||||
There are two ways to login:
|
||||
> In both cases, the authentication token is stored securely in the default OS-specific keyring.
|
||||
|
||||
**Username / Password login**
|
||||
|
||||
1. Run `discordo` without arguments.
|
||||
2. Enter your email and password then click on the "Login" button to continue.
|
||||
|
||||
**Token login**
|
||||
|
||||
Use the `--token` flag:
|
||||
|
||||
```
|
||||
discordo --token "OTI2MDU5NTQxNDE2Nzc5ODA2.Yc2KKA.2iZ-5JxgxG-9Ub8GHzBSn-NJjNg"
|
||||
```
|
||||
|
||||
## Keybindings
|
||||
|
||||
Keybindings are configurable in the [configuration file](#configuration).
|
||||
|
||||
| Action | Keybinding |
|
||||
| --------------------- | ---------- |
|
||||
| **Guilds Tree** | |
|
||||
| Focus | Alt + g |
|
||||
| | |
|
||||
| **Messages Text** | |
|
||||
| Focus | Alt + m |
|
||||
| Show image | i |
|
||||
| Copy message content | c |
|
||||
| Reply without mention | r |
|
||||
| Reply with mention | R |
|
||||
| Select reply | s |
|
||||
| Reply previous | Up arrow |
|
||||
| Select next | Down arrow |
|
||||
| Select first | Home |
|
||||
| Select last | End |
|
||||
| | |
|
||||
| **Message Input** | |
|
||||
| Focus | Alt + i |
|
||||
| Send message | Enter |
|
||||
| Paste from clipboard | Ctrl + v |
|
||||
| Launch editor | Ctrl + e |
|
||||
|
||||
## Configuration
|
||||
|
||||
The configuration file allows you to edit keybindings or change the theme.
|
||||
By default, it is stored in the following location:
|
||||
|
||||
| Operating System | Configuration File Location |
|
||||
| ---------------- | ------------------------------------------------------- |
|
||||
| Unix | `$HOME/.config/discordo/config.yml` |
|
||||
| Darwin | `$HOME/Library/Application Support/discordo/config.yml` |
|
||||
| Windows | `%AppData%/discordo/config.yml` |
|
||||
|
||||
You can also use the `--config` flag to specify a different location for the configuration file:
|
||||
|
||||
```
|
||||
discordo --config "/foo/bar/config.yml"
|
||||
```
|
||||
|
||||
|
||||
## Log files
|
||||
|
||||
The log file is stored in the following location:
|
||||
|
||||
| Operating System | Log File Location |
|
||||
| ---------------- | ---------------------------------------- |
|
||||
| Unix | `$HOME/.cache/discordo/logs.txt` |
|
||||
| Darwin | `$HOME/Library/Caches/discordo/logs.txt` |
|
||||
| Windows | `%LocalAppData%/discordo/logs.txt` |
|
||||
|
|
@ -1,65 +0,0 @@
|
|||
discordo 1
|
||||
=======================================
|
||||
|
||||
NAME
|
||||
----
|
||||
|
||||
`discordo` - A lightweight, secure, and feature-rich Discord terminal client
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
`discordo` [`--token "TOKEN"`] [`--config "OPTIONAL/PATH/HERE.yml"`]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
`discordo` is a lightweight, secure, and feature-rich Discord terminal client.
|
||||
|
||||
If no token is provided, you will be prompted with an interactive login.
|
||||
The token is stored securely in the default OS-specific keyring.
|
||||
|
||||
USAGE
|
||||
-------
|
||||
|
||||
The default keybindings in the app are as follow
|
||||
|
||||
### Guilds Tree
|
||||
|
||||
| Action | Keybinding |
|
||||
| ------ | ---------- |
|
||||
| Focus | Alt + g |
|
||||
| Toggle | Alt + b |
|
||||
|
||||
### Messages Text
|
||||
|
||||
| Action | Keybinding |
|
||||
| --------------------- | ---------- |
|
||||
| Focus | Alt + m |
|
||||
| Show image | i |
|
||||
| Copy message content | c |
|
||||
| Reply without mention | r |
|
||||
| Reply with mention | R |
|
||||
| Select reply | s |
|
||||
| Reply previous | Up arrow |
|
||||
| Select next | Down arrow |
|
||||
| Select first | Home |
|
||||
| Select last | End |
|
||||
|
||||
### Message Input
|
||||
|
||||
| Action | Keybinding |
|
||||
| -------------------- | ---------- |
|
||||
| Focus | Alt + i |
|
||||
| Send message | Enter |
|
||||
| Paste from clipboard | Ctrl + v |
|
||||
| Launch editor | Ctrl + e |
|
||||
|
||||
FILES
|
||||
-----
|
||||
|
||||
*$HOME/.config/discordo/config.yml*
|
||||
The configuration file.
|
||||
|
||||
*$HOME/.cache/discordo/logs.txt*
|
||||
The log file.
|
||||
Loading…
Add table
Reference in a new issue