Forráskód Böngészése

docs: separate authentication and add toc

ayn2op 2 éve
szülő
commit
a0730f5c35
2 módosított fájl, 21 hozzáadás és 17 törlés
  1. 5 17
      docs/README.md
  2. 16 0
      docs/configuration.md

+ 5 - 17
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:

+ 16 - 0
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"
+```