Update Installation instructions

This commit is contained in:
rigormorrtiss 2021-07-23 23:11:07 +04:00
parent aeaf245fb5
commit dcb639a45f

View file

@ -2,37 +2,27 @@
[WIP] Lightweight Discord terminal client
![preview](assets/preview.png)
![Preview](assets/preview.png)
## Features
- **Lightweight**: Designed to have a low memory footprint and low CPU usage, overall a low usage of system resources.
- **Secure**: Securely stores credentials (email, password, or authentication token) in OS-specific keyring file.
- **Secure**: Securely stores the authentication token on first login in an OS-specific keyring file.
## Installation
### Building from Source
- Run the following commands in chronological order.
```
git clone https://github.com/rigormorrtiss/discordo
cd discordo
cp build/discordo_linux_amd64 /usr/local/bin/discordo
cd discordo && go build
```
Binary name examples:
- `discordo_linux_amd64`
- `discordo_darwin_amd64`
- `discordo_windows_amd64.exe`
## Usage
- Run the executable by running the following command in a terminal.
```
discordo
```
- Run the built executable in a new Terminal.
- Choose the preferred login method.
- Log in using the chosen login method and click on "Login" button to continue.
Note: bot accounts must be prefixed with "Bot ".