Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SanjaySunil committed Nov 3, 2024
1 parent e269a0b commit 4521e7b
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

<!-- Logo -->
<p align="center">
<a href="https://github.com/sanjaysunil/betterdiscordpanel">
Expand All @@ -7,15 +8,14 @@

<!-- Title -->
<h1 align="center">BetterDiscordPanel</h1>
<p align="center">
<p align="center">
Discord Messaging Panel that allows you to message inside of a bot!
<br />
<br />
<a href="https://github.com/SanjaySunil/BetterDiscordPanel/issues/new?assignees=&labels=Bug&template=bug_report.md&title=%5BBUG%5D">Report Bug</a>
·
<a href="https://github.com/SanjaySunil/BetterDiscordPanel/issues/new?assignees=&labels=Suggestions&template=suggestions.md&title=%5BSUGGESTION%5D">Request Feature</a>
</p>
</h1>
</p>
<br/><br/>

<!-- Preview -->
Expand All @@ -30,11 +30,22 @@
</p>
<br/>

<h2 align="center">Special Thanks to Globium Designs</h2>
<div align="center">
<br/>
<img src="https://www.globiumdesigns.com/icon.png" width="25%"/>
<br/><br/>
</div>

Looking for custom-tailored project solutions? At **Globium Designs**, we specialise in creating innovative digital solutions tailored to your unique business needs. Whether you need web development, app development, or branding services, we are here to help you succeed.

Contact us at [[email protected]](mailto:[email protected]) for inquiries and let us bring your vision to life!

<!-- Information -->

## What's BetterDiscordPanel?

<a href="https://github.com/betterdiscordpanel" target="_blank">BetterDiscordPanel</a> is a new panel that allows you to message, manage and gain statistics inside of your discord bot.
[BetterDiscordPanel](https://github.com/betterdiscordpanel) is a new panel that allows you to message, manage and gain statistics inside of your discord bot.
<br/>

<!-- Features -->
Expand All @@ -43,8 +54,8 @@

- 📊 **Discord Bot Statistics:** Gain full insights and details of your discord bot with server and bot information.
- 💬 **Simple Messaging Interface:** BetterDiscordPanel allows you to easily message users and chat within servers using your discord bot. The panel also has a light and dark theme to suit your needs!
- 🔒 **Security:** BetterDiscordPanel does not run on any servers and can be self hosted. All bot details are stored locally and is completely secure.
- 👀 **Opensource:** BetterDiscordPanel is open source on GitHub so you can see all the code behind the project.
- 🔒 **Security:** BetterDiscordPanel does not run on any servers and can be self-hosted. All bot details are stored locally and is completely secure.
- 👀 **Open Source:** BetterDiscordPanel is open source on GitHub so you can see all the code behind the project.

<br/>

Expand All @@ -58,6 +69,7 @@ Simply open `index.html` to open the web version of BetterDiscordPanel or use th
<!-- Installation -->

### **Step 1:** Prerequisites

To use the **desktop application** of BetterDiscordPanel, you will need to have the following installed.

- Node.js
Expand All @@ -68,22 +80,23 @@ To use the **desktop application** of BetterDiscordPanel, you will need to have
> ⚠️ **NOTE**: To use the **web version** of BetterDiscordPanel, you will need to set a custom User Agent.
[Setting a custom User Agent](./docs/prerequisites/prerequisites.md)

### **Step 2:** Setup / Installation

1. Clone the repository

```sh
git clone https://github.com/sanjaysunil/betterdiscordpanel
```
```sh
git clone https://github.com/sanjaysunil/betterdiscordpanel
```

> ⚠️ **NOTE**: The updater only works if you have cloned the repository.
> ⚠️ **NOTE**: The updater only works if you have cloned the repository.
2. Open `login.html` for the web application or open `BetterDiscordPanel.cmd` to run the desktop application.

3. Login to your discord bot using your discord bot token.
3. Log in to your discord bot using your discord bot token.

4. Start using BetterDiscordPanel!
<br/>
<br/>

<!-- ROADMAP -->

Expand All @@ -96,7 +109,7 @@ See the [open issues](https://github.com/sanjaysunil/betterdiscordpanel/issues)

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

View [translation guide](https://github.com/SanjaySunil/BetterDiscordPanel/blob/master/.github/TRANSLATION.md).

Expand Down Expand Up @@ -125,6 +138,6 @@ View [contribution guide](https://github.com/SanjaySunil/BetterDiscordPanel/blob

## License

Copyright © 2022 Sanjay Sunil (sanjaysunil@protonmail.com)
Copyright © 2024 Sanjay Sunil (contact@sanjaysunil.com)

Distributed under the GNU General Public License v3.0. See `LICENSE` for more information.

0 comments on commit 4521e7b

Please sign in to comment.