From 3f5d091fd09176437b7d9063dbba9d5a33362231 Mon Sep 17 00:00:00 2001 From: kz-n <64893077+kz-n@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:13:10 +0100 Subject: [PATCH 1/5] Changes to landing section and title --- README.md | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f9ed8db..b212e0e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,35 @@ -

+
-

- -ArmCord is a custom client designed to enhance your Discord experience while keeping everything lightweight. +
ArmCord is a custom client designed to enhance your Discord experience while keeping everything lightweight. + # Features -* **Standalone client** - ArmCord is built as standalone client, it doesn't rely on original Discord client. -* **Various mods built in** - Explore Cumcord/GooseMod/Flicker plugins and their features! -* **Made for Privacy** - ArmCord automatically blocks Discord's trackers. -* **Faster than normal Discord app** - ArmCord is using newer Electron than stock Discord app. This usually means increased performance and more stable experience. -* **Designed to work anywhere** - ArmCord was initially created in mind to run on Arm64 Linux devices. We soon expanded our support to more platforms. We plan to support every platform that [Electron supports](https://www.electronjs.org/docs/latest/tutorial/support#supported-platforms). +- **Standalone client** + + ArmCord is built as standalone client, it doesn't rely on original Discord client. + + +- **Various mods built in** + + Explore Cumcord/GooseMod/Flicker plugins and their features! + + +- **Made for Privacy** + + ArmCord automatically blocks Discord's trackers. + + +- **Faster than normal Discord app** + + ArmCord is using newer Electron than stock Discord app. This usually means increased performance and more stable experience. + + +- **Designed to work anywhere** + + ArmCord was initially created in mind to run on Arm64 Linux devices. We soon expanded our support to more platforms. We plan to support every platform that [Electron supports](https://www.electronjs.org/docs/latest/tutorial/support#supported-platforms). + # How to run/install it? ### Recommended: Check releases tab for precompiled packages for Linux, Windows and Mac OS (experimental). From 643611b5097c11499df80efd4ef6f0ae3f097c3e Mon Sep 17 00:00:00 2001 From: kz-n <64893077+kz-n@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:13:49 +0100 Subject: [PATCH 2/5] Easier to read --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b212e0e..192c44a 100644 --- a/README.md +++ b/README.md @@ -35,19 +35,19 @@ Check releases tab for precompiled packages for Linux, Windows and Mac OS (experimental). ### Manual: Alternatively you can run ArmCord from source (npm, nodejs required): -1.Clone ArmCord repo: `git clonehttps://github.com/ArmCord/ArmCord.git` -2.Run `npm install` to install dependencies -3.Compile/Package with `npm run package` +1. Clone ArmCord repo: `git clonehttps://github.com/ArmCord/ArmCord.git` +2. Run `npm install` to install dependencies +3. Compile/Package with `npm run package` # FAQ -## 1.Will I get banned from using it? +## 1. Will I get banned from using it? -You are breaking Discord ToS if you decided to use client mods. But no one ever got banned from using ArmCord or any of the client mods included. If you wish to remove mods, check our documentation. -## 2.How does this work? +## 2. How does this work? -We are using official web app and adding some magic powder to make it all work! -## 3.Can I use this on other architectures or operating systems? +## 3. Can I use this on other architectures or operating systems? -Yes! ArmCord should work normally under Windows, ~~Mac OS~~ (Mac OS is broken see [#48](https://github.com/ArmCord/ArmCord/issues/48)) and Linux as long as it has NodeJS, npm and Electron support. From 65522c971865985c1441f0c6a81a005020b54aa3 Mon Sep 17 00:00:00 2001 From: kz-n <64893077+kz-n@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:15:16 +0100 Subject: [PATCH 3/5] Spelling mistake --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 192c44a..1443007 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,12 @@ # How to run/install it? ### Recommended: -Check releases tab for precompiled packages for Linux, Windows and Mac OS (experimental). + Check releases tab for precompiled packages for Linux, Windows and Mac OS (experimental). ### Manual: -Alternatively you can run ArmCord from source (npm, nodejs required): -1. Clone ArmCord repo: `git clonehttps://github.com/ArmCord/ArmCord.git` -2. Run `npm install` to install dependencies -3. Compile/Package with `npm run package` + Alternatively you can run ArmCord from source (npm, nodejs required): + 1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git` + 2. Run `npm install` to install dependencies + 3. Compile/Package with `npm run package` # FAQ From c2bd002968948bd642549d7a56e86dfeb9250a39 Mon Sep 17 00:00:00 2001 From: kz-n <64893077+kz-n@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:23:09 +0100 Subject: [PATCH 4/5] Further notice on mac os builds not working --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1443007..2b122fd 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ # How to run/install it? ### Recommended: - Check releases tab for precompiled packages for Linux, Windows and Mac OS (experimental). + Check releases tab for precompiled packages for Linux, Windows and ~~Mac OS~~ (Mac OS is broken see [#48](https://github.com/ArmCord/ArmCord/issues/48)). ### Manual: Alternatively you can run ArmCord from source (npm, nodejs required): 1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git` From 36f94bc404d202f325f12f633b5bd68e5f0f17b7 Mon Sep 17 00:00:00 2001 From: kz-n <64893077+kz-n@users.noreply.github.com> Date: Mon, 17 Jan 2022 14:55:16 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2b122fd..dd33b82 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,14 @@ # How to run/install it? ### Recommended: Check releases tab for precompiled packages for Linux, Windows and ~~Mac OS~~ (Mac OS is broken see [#48](https://github.com/ArmCord/ArmCord/issues/48)). + +### AUR Package +Armcord is also available on the Arch User Repository (AUR) [here](https://aur.archlinux.org/packages/armcord-bin/). + +Install it via an AUR helper tool like `yay`. + +**Example:** `yay -S armcord-bin` + ### Manual: Alternatively you can run ArmCord from source (npm, nodejs required): 1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git`