Skip to content

Commit 58feadd

Browse files
committed
2 parents 42cd39c + 4ed5b4a commit 58feadd

1 file changed

Lines changed: 69 additions & 54 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 69 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,41 @@
11
<div align="center">
2-
<img height="120px" src=".github/logo.png" alt="Boostify Logo" />
3-
<h1>Boostify</h1>
4-
<p><strong>Maximize your Discord server boost management</strong></p>
5-
<img src="https://img.shields.io/github/actions/workflow/status/teamboostify/boostify/node.js.yml?style=flat-square" />
6-
<img src="https://img.shields.io/github/license/teamboostify/boostify?style=flat-square&color=FF47B5" />
7-
<img src="https://img.shields.io/github/v/tag/teamboostify/boostify?style=flat-square&color=FF47B5" />
8-
<img src="https://img.shields.io/github/forks/teamboostify/boostify?style=flat-square&color=FF47B5" />
9-
<img src="https://img.shields.io/github/checks-status/teamboostify/boostify/main?style=flat-square&color=FF47B5" /><br />
10-
<img src="https://img.shields.io/github/stars/teamboostify/boostify?style=flat-square&color=FF47B5" />
11-
<a href="https://discord.gg/vZgeWhZ9aF">
12-
<img src="https://img.shields.io/discord/1453868977720922287?style=flat-square&logo=Discord&logoColor=white&label=Support%20Server&color=7289da" />
13-
</a>
2+
3+
<img height="120px" src=".github/logo.png" alt="Boostify Logo">
4+
5+
<h1>Boostify</h1>
6+
7+
<p>
8+
<strong>Maximize your Discord server boost management</strong>
9+
</p>
10+
11+
<p>
12+
<img src="https://img.shields.io/github/actions/workflow/status/teamboostify/boostify/node.js.yml?branch=main&style=flat-square" alt="Build Status">
13+
<img src="https://img.shields.io/github/license/teamboostify/boostify?style=flat-square&color=FF47B5" alt="License">
14+
<img src="https://img.shields.io/github/v/tag/teamboostify/boostify?style=flat-square&color=FF47B5" alt="Version">
15+
<img src="https://img.shields.io/github/forks/teamboostify/boostify?style=flat-square&color=FF47B5" alt="Forks">
16+
<img src="https://img.shields.io/github/stars/teamboostify/boostify?style=flat-square&color=FF47B5&cacheSeconds=60" alt="Stars">
17+
</p>
18+
19+
<p>
20+
<a href="https://discord.gg/vZgeWhZ9aF">
21+
<img src="https://img.shields.io/discord/1453868977720922287?style=flat-square&logo=discord&logoColor=white&label=Support%20Server&color=5865F2" alt="Discord">
22+
</a>
23+
</p>
24+
1425
</div>
1526

16-
### Overview
27+
---
28+
29+
# πŸ“– Overview
1730

1831
> [!NOTE]
19-
> **Boostify** is a work-in-progress project. While our team ensures everything in our platform works flawlessly, you're more than welcome to make an issue if you find an issue. Please join our Discord server if you require any assistance: [discord.gg/vZgeWhZ9aF](https://discord.gg/vZgeWhZ9aF).
32+
> **Boostify is currently a work-in-progress project.**
33+
>
34+
> Our team is actively improving stability, adding new features, and making Boostify better every release. If you encounter an issue, please open a GitHub issue or join our Discord server for support.
2035
2136
---
2237

23-
# Quick Start
38+
# πŸš€ Quick Start
2439

2540
Get Boostify running in minutes using the official cloud version or self-host it yourself.
2641

@@ -39,9 +54,7 @@ The fastest way to start using Boostify.
3954

4055
## 1. Invite Boostify
4156

42-
Invite Boostify to your Discord server:
43-
44-
πŸ‘‰ https://discord.com/oauth2/authorize?client_id=1453802179789066442
57+
[Invite Boostify](https://discord.com/oauth2/authorize?client_id=1453802179789066442)
4558

4659
---
4760

@@ -64,14 +77,12 @@ Boostify requires the following permissions:
6477

6578
Once invited, configure features like:
6679

67-
- Booster reward roles
68-
- Auto thank-you messages
69-
- Logging
70-
- Moderation
71-
- Booster analytics
72-
- Freemium perks
73-
74-
Continue to the documentation for advanced configuration.
80+
- 🎁 Booster reward roles
81+
- πŸ’¬ Auto thank-you messages
82+
- πŸ“œ Logging
83+
- πŸ›‘οΈ Moderation
84+
- πŸ“Š Booster analytics
85+
- ⚑ Freemium perks
7586

7687
---
7788

@@ -81,16 +92,16 @@ Self-host Boostify for full control and customization.
8192

8293
---
8394

84-
## Requirements
95+
# Requirements
8596

86-
### Required
97+
## Required
8798

8899
- Node.js 20+
89100
- PostgreSQL
90101
- Git
91102
- Discord Bot Token
92103

93-
### Optional
104+
## Optional
94105

95106
- Docker
96107
- PM2
@@ -104,8 +115,9 @@ Self-host Boostify for full control and customization.
104115

105116
```bash
106117
git clone https://github.com/teamboostify/boostify.git
118+
107119
cd boostify
108-
````
120+
```
109121

110122
---
111123

@@ -168,12 +180,13 @@ npm run dev
168180

169181
```bash
170182
npm run build
183+
171184
npm start
172185
```
173186

174187
---
175188

176-
# Docker Deployment
189+
# 🐳 Docker Deployment
177190

178191
Boostify supports Docker deployments out of the box.
179192

@@ -194,43 +207,45 @@ docker run -d \
194207

195208
---
196209

197-
# Recommended Production Stack
210+
# πŸ—οΈ Recommended Production Stack
198211

199-
For the best production experience, we recommend:
212+
For the best production experience:
200213

201-
* Docker
202-
* PM2
203-
* Linux VPS
204-
* Managed PostgreSQL
205-
* Reverse Proxy (Nginx or Caddy)
214+
- Docker
215+
- PM2
216+
- Linux VPS
217+
- Managed PostgreSQL
218+
- Reverse Proxy (Nginx or Caddy)
206219

207220
---
208221

209-
# Features
222+
# ✨ Features
210223

211-
* πŸš€ Boost Tracking
212-
* 🎁 Reward Roles
213-
* πŸ’¬ Auto Thank-You Messages
214-
* πŸ“Š Booster Analytics
215-
* πŸ›‘οΈ Moderation
216-
* πŸ“œ Logging
217-
* ⚑ Freemium Perks
218-
* 🐳 Docker Support
219-
* πŸ”§ Self Hosting
220-
* 🌐 Cloud Hosted Version
224+
- πŸš€ Boost Tracking
225+
- 🎁 Reward Roles
226+
- πŸ’¬ Auto Thank-You Messages
227+
- πŸ“Š Booster Analytics
228+
- πŸ›‘οΈ Moderation
229+
- πŸ“œ Logging
230+
- ⚑ Freemium Perks
231+
- 🐳 Docker Support
232+
- πŸ”§ Self Hosting
233+
- 🌐 Cloud Hosted Version
221234

222235
---
223236

224-
# Support
237+
# ❀️ Support
225238

226239
Need help?
227240

228-
* Join the support server: [https://discord.gg/vZgeWhZ9aF](https://discord.gg/vZgeWhZ9aF)
229-
* Open an issue on GitHub
230-
* Check the documentation
241+
- πŸ’¬ [Join the Discord Support Server](https://discord.gg/vZgeWhZ9aF)
242+
- 🐞 [Open a GitHub Issue](https://github.com/teamboostify/boostify/issues/new/choose)
243+
- πŸ“– [Read the Documentation](https://docs.boostify.breaddevv.cc/)
231244

232245
---
233246

234247
<div align="center">
235-
Made with ❀️ by Team Boostify
248+
249+
Made with ❀️ by **Team Boostify**
250+
236251
</div>

0 commit comments

Comments
Β (0)