From a0730f5c35ba525abf3ac962da332346fbfc2fa5 Mon Sep 17 00:00:00 2001 From: ayn2op Date: Wed, 21 Jun 2023 17:01:32 +0530 Subject: [PATCH] docs: separate authentication and add toc --- docs/README.md | 22 +++++----------------- docs/configuration.md | 16 ++++++++++++++++ 2 files changed, 21 insertions(+), 17 deletions(-) create mode 100644 docs/configuration.md diff --git a/docs/README.md b/docs/README.md index 6e255eb..1fd750d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,11 @@ Discordo is a lightweight, secure, and feature-rich Discord terminal client. +## Table of Contents + +- [FAQ](./faq.md) +- [Configuration](./configuration.md) + ## 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. @@ -52,23 +57,6 @@ Keybindings are configurable in the [configuration file](#configuration). | 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: diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..770d86a --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,16 @@ +## 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" +```