Reorder topics and rewrite some stuff to make it more straightforward
MODIFY
README.md
README.md
## Overview
- [Credits](#credits)
-- [How to install it](#how-to-install-it)
+- [How to install it](#installation)
- [Installing on Linux](#installing-on-linux)
- [Snap](#snap)
- [Arch based Linux distributions](#arch-based-linux-distributions)
- [Similar projects](#similar-projects)
- [Troubleshooting](#troubleshooting)
+**WARNING: Third party clients are discouraged and against the Discord TOS.**
+
Cordless is supposed to be a custom [Discord](https://discordapp.com) client
that aims to have a low memory footprint and be aimed at power-users.
-**WARNING: Self-bots are discouraged and against Discords TOS.**
-
-This project was mainly inspired by [Southclaws](https://github.com/Southclaws)
-[Cordless](https://github.com/Southclaws/cordless-old), which he sadly didn't
-develop any further.
-
The application only uses the official Discord API and doesn't send data to
any third party. However, this application is not a official product
by Discord Inc.
-For those who don't want to use paypal but still donate, here's my ETH wallet public key:
-0x49939106563a9de8a777Cf5394149423b1dFd970
-
![Demo Screenshot](.github/images/chat-demo.png)
-## Credits
-
-Big thanks to [JetBrains](https://www.jetbrains.com/?from=cordless) for providing the
-cordless project with free licenses!
-
-## How to install it
+## Installation
### Installing on Linux
@@ -93,6 +81,7 @@ $ makepkg -sric
##### With AUR Helpers:
###### yay:
+
```shell
$ yay -Syu cordless-git
```
@@ -102,36 +91,34 @@ $ yay -S cordless-git
```
###### trizen:
+
```shell
$ trizen -S cordless-git
```
###### pacaur
+
```shell
$ pacaur -S cordless-git
```
### Installing on Windows
-In order to install the latest version on Windows, you first need
+In order to install the latest version on Windows, you first need to install
[scoop](https://scoop.sh/#installs-in-seconds).
After installing scoop, run the following:
-```ps1
-scoop bucket add biosmarcel https://github.com/Bios-Marcel/scoopbucket.git
-```
-
-This adds the bucket (repository) to your local index, allowing you to
-install any package from that bucket.
-
-Install cordless via
+This adds the bucket (repository) that contains cordless to your local scoop
+installation, allowing you to install any package it contains. Afterwards
+it installs cordless for your current windows user.
```ps1
+scoop bucket add biosmarcel https://github.com/Bios-Marcel/scoopbucket.git
scoop install cordless
```
-In order to install updates, run:
+Updates can be installed via:
```ps1
scoop update cordless
@@ -146,8 +133,8 @@ brew tap Bios-Marcel/cordless
brew install cordless
```
-If you don't install via homebrew, then you should get `pngpaste`, since it's
-what allows you to paste images.
+If you don't install via cordless via brew, then you should have to get
+`pngpaste` in order to be able to paste image data.
### Building from source
@@ -192,12 +179,15 @@ Note:
Logging in works via the UI on first startup of the application.
If you are logging in with a bot token, you have to prepend `Bot ` (yes, with
-the space) in front of the token. Pasting only works via your terminals normal pasting shortcut.
+the space) in front of the token. Pasting only works via your terminals normal
+pasting shortcut.
-**THIS APPLICATION NEVER SAVES YOUR ACTUAL PASSWORD LOCALLY.**
+**YOUR PASSWORD IS NEVER SAVED LOCALLY.**
If you need to find out how to retrieve your token, [check the wiki at](https://github.com/Bios-Marcel/cordless/wiki/Retrieving-your-token).
+**Currently captcha-code login isn't supported.**
+
## Quick overview - Navigation (switching between boxes / containers)
| Shortcut | Action |
@@ -220,6 +210,40 @@ changer via <kbd>Ctrl</kbd> + <kbd>K</kbd>.
[Check the wiki](https://github.com/Bios-Marcel/cordless/wiki/Extending-Cordless-via-the-scripting-interface)
+## Troubleshooting
+
+If you happen to encounter a crash or a bug, please submit a bug report via
+the projects GitHub issue tracker. It's highly likely that issues messaged
+via discord will be forgotten.
+
+For general problems faced by cordless users, check out the wiki at:
+https://github.com/Bios-Marcel/cordless/wiki/Troubleshooting
+
+If you need help or have questions that you don't want to create an issue
+for, just join our Discord server: https://discord.gg/fxFqszu
+
+# FAQ
+
+In order to find answers to common questions, check out the FAQ in the wiki:
+
+https://github.com/Bios-Marcel/cordless/wiki/FAQ
+
+## Why should or shouldn't you use this project
+
+Reasons to use it:
+
+- Your PC is not very powerful
+- You're on a mobile device and value your battery life
+- You want to reduce your bandwidth usage
+- You just like terminal applications
+
+Reasons not to use it:
+
+- You like fancy GUI
+- You want to see images, videos and whatnot inside of the application itself
+- You need the voice/video calling features (This might soon change!)
+- You need to administrate a server (no administration features yet)
+
## Contributing
All kinds of contributions are welcome. Whether it's correcting typos, fixing
@@ -240,22 +264,10 @@ If none of those ways of contributing are your kind of thing, feel free to
donate something via [Liberapay](https://liberapay.com/biosmarcel/donate).
It may not directly have an impact on the project, but it will surely motivate
me to keep working on this project, as it shows that people care about it.
+Also, who doesn't like money???
-## Why should or shouldn't you use this project
-
-Reasons to use it:
-
-- Your PC is not very powerful
-- You're on a mobile device and value your battery life
-- You want to reduce your bandwidth usage
-- You just like terminal applications
-
-Reasons not to use it:
-
-- You like fancy GUI
-- You want to see images, videos and whatnot inside of the application itself
-- You need the voice/video calling features (This might soon change!)
-- You need to administrate a server (no administration features yet)
+For those who don't want to use paypal, but still want to donate, here's
+my ETH wallet public key: `0x49939106563a9de8a777Cf5394149423b1dFd970`
## Similar projects
@@ -269,14 +281,11 @@ Here is a list of similar projects:
Hit me up if you have a similar project and I'll gladly add it to the list.
-## Troubleshooting
-
-If you happen to encounter a crash or a bug, please submit a bug report via
-the projects GitHub issue tracker.
+## Credits
-For general problems faced by cordless users, check out the wiki at:
-https://github.com/Bios-Marcel/cordless/wiki/Troubleshooting
+Big thanks to [JetBrains](https://www.jetbrains.com/?from=cordless) for providing the
+cordless project with free licenses!
-If you need help or have questions that you don't want to create an issue for.
-feel free to hit me up on Discord: `Marcel#5587`. Alternatively, just join the
-public Cordless server linked at the top of the Readme.
+This project was mainly inspired by [Southclaws](https://github.com/Southclaws)
+[Cordless](https://github.com/Southclaws/cordless-old), which he sadly didn't
+develop any further.

Reorder topics and rewrite some stuff to make it more straightforward