Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Zwylair committed Aug 24, 2024
1 parent 23c5641 commit 27ece06
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
</h1>

<p align="center">
<img src="https://img.shields.io/badge/python-3.11-green?logo=python&logoColor=white&style=for-the-badge">
<img src="https://img.shields.io/badge/python-3.12-green?logo=python&logoColor=white&style=for-the-badge">
<img src="https://img.shields.io/badge/LICENSE-MIT-green?style=for-the-badge">
<img src="https://img.shields.io/github/languages/code-size/Zwylair/BetterDiscordAutoInstaller?style=for-the-badge">
</p>

## About

`BetterDiscordAutoInstaller` is a script that has the functionality of the official [BetterDiscord installer](https://betterdiscord.app/) of applying this mod on Discord (non canary, etc.). It automatically downloads `betterdiscord.asar` file from the official [BetterDiscord GitHub repo](https://github.com/BetterDiscord/BetterDiscord) and adds into loading modules.
`BetterDiscordAutoInstaller` is a **Windows-only** script that works as the official [BetterDiscord installer](https://betterdiscord.app/). This script applies mod on **default** Discord (non canary, etc.). It automatically downloads `betterdiscord.asar` file from the official [BetterDiscord GitHub repo](https://github.com/BetterDiscord/BetterDiscord) and adds into loading modules.

`BetterDiscordAutoInstaller` also allows you to add/remove it from autostart, without having to run it manually every time (only Windows for now) (use `startup_manager`).
`BetterDiscordAutoInstaller` also allows you to add/remove it from autostart, without having to run it manually every time (use `startup_manager`).

## Setup and Dependencies

Expand All @@ -30,9 +30,21 @@ py -m pip install -r requirements.txt

Run the script:
```bash
py installer.py
py main.py
```

## Contribution

I will be grateful for any contribution and help given to improve the quality of the project :)

_(especially about adapting the project to other platforms like linux, macos :3)_

## Fork

Well, just fork it

**But please, don't forget to mention original project in your README**

## License

This project is under the [MIT license](./LICENSE).

0 comments on commit 27ece06

Please sign in to comment.