From 2ac716ed18a4469484411b7503830ef7316c1e3a Mon Sep 17 00:00:00 2001 From: Phorcys <64284419+phorcysed@users.noreply.github.com> Date: Wed, 10 Jun 2020 23:19:54 +0200 Subject: [PATCH] Better readme: Added features list, TO-DO & more --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 47 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9aeef8c..879e6c7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ +[![PayPal](https://img.shields.io/badge/donate-PayPal-blue?logo=PayPal&style=flat-square)](https://paypal.me/jenwina) +[![BTC](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/bitcoin.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/btc.html?address=14hL2fPS2ASoe8Hcif87EqCS5AGHrepGKp¬e=https://github.com/phorcysed) +[![CDN](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/cdn.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/cdn.html?address=CbdW3pR4HBWJ6wyc1JeNXP4L2fh8QiL85v¬e=https://github.com/phorcysed) +[![BCH](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/bitcoincash.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/bch.html?address=qzqwhfyvkl324fue86r55q656nftfmxkhsn6qugenq¬e=https://github.com/phorcysed) +[![XMR](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/monero.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/xmr.html?address=42pGf1KHHpqaifJd3TtWSdcTmhGVwFp24cGxDoqaYLQJ6rH4pM7KqtUdTpoyxHScDTSJpPA2Bnv19b1bs2uPXgSMH2KYkwj¬e=https://github.com/phorcysed) +[![ETH](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/ethereum.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/eth.html?address=0xEFE45F22Ee844bf2Ba0E4d853FA0bC8c028fAfFe¬e=https://github.com/phorcysed) +[![LTC](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/litecoin.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/ltc.html?address=LNTmfMjHJgTHaB7rj8ZuWWuU1XkP2YeGCA¬e=https://github.com/phorcysed) +[![DASH](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/dash.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/dash.html?address=XvdDn9gjqeBhYdC9ydPSYbqEdM49YpVqHx¬e=https://github.com/phorcysed) +[![XRP](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/phorcysed/cryptodonate/master/badges/ripple.json&style=flat-square)](https://phorcysed.github.io/cryptodonate/xrp.html?address=rELWE8F2QpKPDqb9poNrjXQJpf2fnevvYM¬e=https://github.com/phorcysed) +
+[![Discord](https://img.shields.io/discord/705908350218666117?logo=discord&style=flat-square&color=%237289DA)](https://discord.gg/7eFff2A) +--- # Lightcord A simple - customizable - Discord Client @@ -8,28 +20,55 @@ It includes [BandagedBD](https://github.com/rauenzi/BetterDiscordApp), [Glasscor ## Informations Lightcord doesn't *patch* Discord with it's content. If it would, Discord will update itself and break the patch. That's why Lightcord is a standalone Discord client. Just grab the latest release version you need, and launch it ! -## Installation -You can install it from the release tab. +## Installing +You can download a release from the [releases tab](https://github.com/Lightcord/Lightcord/releases). -If you want to `git clone` it and launch it, follow these instructions: +If you want to run it from source, follow these instructions: ```sh -git clone https://github.com/JeanOUINA/Lightcord +git clone https://github.com/Lightcord/Lightcord cd Lightcord npm i +npm run devInstall npm run test ``` Discord will launch next. You can see you have done it right by looking at the icon. -![icon](https://i.imgur.com/rHnsPNO.png) +![icon](https://raw.githubusercontent.com/Lightcord/Lightcord/master/imagery/68747470733a2f2f692e696d6775722e636f6d2f72486e73504e4f2e706e67.png?token=APKOOA2LWWLCCUO2CIT2YPK64FHJA) +Then everytime you want to launch it just type in +```sh +npm run run +``` + +## Features +* **BetterDiscord** Themes/Plugins +* **Native** Custom RPC (No ban chance) +* Blocking Discord's **trackers** +* **Free emotes** (normal emotes) to use everywhere for Lightcord users +* **Login with token** (user/bot) [Make calls with bots] +* DM Adverts blocker (**AdBlock**) [Even in embeds] +* File certification/approval (tells you if a **file is safe or not**) +* Prevent **malicious** plugins [File scanner] +* **Always-On-Top** feature (great to chat while coding) +* Hide sensitive informations (blurry e-mail) +* Great scripting API +* Account information section +* Developer mode / experiments (get discord features before anyone else without updating) + +### Soon +* Username history +* Custom BetterDiscord location (custom themes/plugins location) [more portability] ## BetterDiscord BetterDiscord (BandagedBD) is already installed (modified version). -You can go into your settings manage plugins. +You can go into your settings to manage plugins. -Because it's more a pain than something good, global emotes are not supported on Lightcord. They have been removed. -Only the freeze at the launch because of the downloading is pretty annoying. So I removed them. +Because it's more painful than anything else, global emotes are not supported on Lightcord. They have been removed. +The freeze caused by the emotes downloading at startup was annoying. So we removed them. ## Plugins & Themes Plugins and themes are not in the standard BetterDiscord folder. They have been moved because betterdiscord supports only stable, ptb and canary release. Using the same directory could cause problems with settings. They are located in `%AppData%/Lightcord_BD`. This is the main folder for BetterDiscord. +## Developers +* https://github.com/jeanouina +* https://github.com/phorcysed