Просмотр исходного кода

docs(README): add comprehensive instructions in usage (#631)

Ayyan 5 месяцев назад
Родитель
Сommit
427a892ed6
1 измененных файлов с 23 добавлено и 2 удалено
  1. 23 2
      README.md

+ 23 - 2
README.md

@@ -53,12 +53,33 @@ go build .
 
 
 ## Usage
 ## Usage
 
 
-1. Run the `discordo` executable with no arguments.
+### Password
 
 
-> If you are logging in using an authentication token, provide the `token` command-line flag to the executable (eg: `--token "OTI2MDU5NTQxNDE2Nzc5ODA2.Yc2KKA.2iZ-5JxgxG-9Ub8GHzBSn-NJjNg"`). Alternatively, set the value of the `DISCORDO_TOKEN` environment variable to the authentication token. The token is stored securely in the default OS-specific keyring.
+1. Run the `discordo` executable with no arguments.
 
 
 2. Enter your email and password and click on the "Login" button to continue.
 2. Enter your email and password and click on the "Login" button to continue.
 
 
+### Token
+
+Provide the `token` command-line flag to the executable. 
+
+```sh
+discordo --token "OTI2MDU5NTQxNDE2Nzc5ODA2.Yc2KKA.2iZ-5JxgxG-9Ub8GHzBSn-NJjNg"
+```
+
+Alternatively, set the value of the `DISCORDO_TOKEN` environment variable to the authentication token.
+
+> [!TIP]
+> You can manually set the token to the keyring using the instructions [here](#manually-adding-token-to-keyring).
+
+### QR
+
+1. Run the `discordo` executable with no arguments.
+
+2. Click on the "Login with QR" button.
+
+3. Follow the instructions in the QR Login screen.
+
 ## Configuration
 ## Configuration
 
 
 The configuration file allows you to configure and customize the behavior, keybindings, and theme of the application.
 The configuration file allows you to configure and customize the behavior, keybindings, and theme of the application.