From f3aa3c161ebedd2b8f1e7d3c8cb1d84dc6d82b9c Mon Sep 17 00:00:00 2001 From: rigormorrtiss Date: Thu, 9 Sep 2021 22:05:12 +0400 Subject: [PATCH] docs: add 'Desktop notifications' to features --- README.md | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 773ded7..efdd22e 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,40 @@ # discordo · [![build](https://github.com/rigormorrtiss/discordo/actions/workflows/build.yml/badge.svg)](https://github.com/rigormorrtiss/discordo/actions/workflows/build.yml) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rigormorrtiss/discordo/blob/master/LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/rigormorrtiss/discordo)](https://goreportcard.com/report/github.com/rigormorrtiss/discordo) -Discordo is a lightweight, secure, and feature-rich Discord terminal client. +Discordo is a lightweight, secure, and feature-rich Discord terminal client. It is highly configurable and has a minimalistic user interface. ![Preview](.github/preview.png) ## Features -- Lightweight & secure -- Easy-to-use & cross-platform -- Configurable & minimalistic +- Lightweight +- Secure +- Configurable +- Cross-platform +- Minimalistic - Feature-rich - - Discord-flavored markdown - - Clipboard support - - 2-Factor Authentication + - Mouse & clipboard support + - 2-Factor authentication + - Desktop notifications + - [WIP] Discord-flavored markdown ## Installation -### Building +### Building from source ```bash git clone https://github.com/rigormorrtiss/discordo -cd discordo && go build +cd discordo +go build # optional sudo mv ./discordo /usr/local/bin ``` -## Package managers +### Package managers -```bash -# (AUR) Arch Linux - development version (may be outdated) -yay -S discordo-git -``` +- Arch Linux (AUR, may be outdated): `paru -S discordo-git` -## Getting Started +## Usage - Run the executable in a new Terminal window. @@ -41,7 +42,7 @@ By default, Discordo utilizes OS-specific keyring to store credentials such as c - Log in using the email and password (first-time login) and click on the "Login" button to continue. -### Default Keybindings +### Default keybindings Global: @@ -57,10 +58,12 @@ TextView: - `G` or `End`: Selects the last message rendered in the TextView. - `r`: Reply to the selected message. -### Clipboard +### Clipboard support -- Requires `xclip` or `xsel` for X11. -- Requires `wl-clipboard` for Wayland. +On Linux, clipboard support requires: + +- `xclip` or `xsel` for X11. +- `wl-clipboard` for Wayland. ## Disclaimer