Update README.md

MythicalLTD · Dec 19, 2024 · 195dcce · 195dcce
1 parent 13c20ea
commit 195dcce
Showing 1 changed file with 57 additions and 99 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -1,123 +1,81 @@
-# !! WARNING !!
-!!
+# ⚠️ WARNING ⚠️
 
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
+## **THIS IS A DEVELOP BRANCH – NEVER INSTALL MYTHICALDASH FROM HERE**
 
-!!
-# !! WARNING !!
-!!
-
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
-
-!!
-# !! WARNING !!
-!!
-
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
-
-!!
-# !! WARNING !!
-!!
-
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
-
-!!
-# !! WARNING !!
-!!
-
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
-
-!!
-# !! WARNING !!
-!!
-
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
-
-!!
-# !! WARNING !!
-!!
-
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
-
-!!
-# !! WARNING !!
-!!
+---
 
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
+# MythicalDash V4
 
-!!
-# !! WARNING !!
-!!
+MythicalDash is a client area/dashboard for the Pterodactyl Game Panel with features for managing client servers and much more.
 
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
+[View the Documentation Here](https://www.mythical.systems/docs/mythicalclient-v4/welcome)
 
-!!
-# !! WARNING !!
-!!
+---
 
-!!! THIS IS A DEVELOP BRANCH NEVER INSTALL MYTHICALDASH FROM HERE !!!
+## 🔍 Compare Dashboards
+
+To help you decide, here’s a comparison of the most commonly used Pterodactyl client dashboards.
+
+### Which One is the Best?
+
+| Feature                     | MythicalDash V4 | MythicalDash V3 | HolaClient | Heliactyl 14 | NorthClient | Dashactyl |
+|-----------------------------|-----------------|-----------------|------------|--------------|-------------|-----------|
+| Server Queue               | ❌              | ✅              | ✅         | ⚠️           | ✅          | ✅        |
+| Essentials Options         | ✅              | ✅              | ✅         | ✅           | ✅          | ✅        |
+| API (Client/Admin)         | ✅              | ✅              | ✅         | ✅           | ✅          | ✅        |
+| Payment Options            | ✅              | ✅              | ✅         | ✅           | ✅          | ✅        |
+| Linkvertise                | ✅              | ✅              | ✅         | ✅           | ✅          | ❌        |
+| Custom Ads                 | ✅              | ✅              | ✅         | ✅           | ❌          | ❌        |
+| Purge System               | ✅              | ✅              | ✅         | ✅           | ❌          | ❌        |
+| Legal (Terms/Privacy)      | ✅              | ✅              | ✅         | ✅           | ❌          | ❌        |
+| CloudFlare TurnStile       | ✅              | ✅              | ✅         | ✅           | ❌          | ❌        |
+| CLI                        | ✅              | ✅              | ⚠️         | ✅           | ❌          | ❌        |
+| Support System             | ✅              | ✅              | ⚠️         | ⚠️           | ❌          | ❌        |
+| Easy Customizations        | ✅              | ✅              | ✅         | ⚠️           | ❌          | ❌        |
+| Runs Everywhere            | ✅              | ✅              | ⚠️         | ✅           | ❌          | ❌        |
+| CSRF                       | ✅              | ✅              | ✅         | ✅           | ❌          | ❌        |
+| Anti XSS                   | ✅              | ✅              | ❌         | ❌           | ❌          | ❌        |
+| Custom (CSS/Header/HTML)   | ✅              | ✅              | ✅         | ✅           | ❌          | ❌        |
+| Custom Search              | ✅              | ✅              | ❌         | ❌           | ❌          | ❌        |
+| Leaderboards               | ✅              | ✅              | ❌         | ❌           | ❌          | ❌        |
+| Health Options             | ✅              | ✅              | ❌         | ❌           | ❌          | ❌        |
+| XChaCha20 Encryption       | ✅              | ⚠️              | ❌         | ❌           | ❌          | ❌        |
+| Easy Translations          | ✅              | ✅              | ❌         | ❌           | ❌          | ❌        |
+| Activity Logs              | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Web Logs                   | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Auto Error Correction      | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Plugin System (Events)     | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Package Manager            | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Renew System               | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Mc Style Permission System | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| 2Factor Auth               | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Unit Tests                 | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Self Backups               | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
+| Announcements              | ✅              | ❌              | ❌         | ❌           | ❌          | ❌        |
 
-!!
-# MythicalDash V4
+---
 
-MythicalDash is a client area/dashboard for the Pterodactyl Game Panel with features for managing client servers and much more.
+## 🛣️ Roadmap
 
-#### Compare Dashboards
-
-Well, we created a table to compare the most commonly used pterodactyl clients, so you can see it for yourself!
-
-### Witch One Is The Best?
-
-|          Feature           | MythicalDash V4 | MythicalDash V3 | HolaClient | Heliactyl 14 | NorthClient | Dashactyl |
-| :------------------------: | :-------------: | :-------------: | :--------: | :----------: | :---------: | :-------: |
-|        Server Queue        |       ❌        |       ✅        |     ✅     |      ⚠️      |     ✅      |    ✅     |
-|     Essentials Options     |       ✅        |       ✅        |     ✅     |      ✅      |     ✅      |    ✅     |
-|     API (Client/Admin)     |       ✅        |       ✅        |     ✅     |      ✅      |     ✅      |    ✅     |
-|      Payment Options       |       ✅        |       ✅        |     ✅     |      ✅      |     ✅      |    ✅     |
-|        Linkvertise         |       ✅        |       ✅        |     ✅     |      ✅      |     ✅      |    ❌     |
-|         Custom Ads         |       ✅        |       ✅        |     ✅     |      ✅      |     ❌      |    ❌     |
-|        Purge System        |       ✅        |       ✅        |     ✅     |      ✅      |     ❌      |    ❌     |
-|  Legal (Terms / Privacy)   |       ✅        |       ✅        |     ✅     |      ✅      |     ❌      |    ❌     |
-|    CloudFlare TurnStile    |       ✅        |       ✅        |     ✅     |      ✅      |     ❌      |    ❌     |
-|            CLI             |       ✅        |       ✅        |     ⚠️     |      ✅      |     ❌      |    ❌     |
-|       Support System       |       ✅        |       ✅        |     ⚠️     |      ⚠️      |     ❌      |    ❌     |
-|    Easy Customizations     |       ✅        |       ✅        |     ✅     |      ⚠️      |     ❌      |    ❌     |
-|      Runs everywhere       |       ✅        |       ✅        |     ⚠️     |      ✅      |     ❌      |    ❌     |
-|            CSRF            |       ✅        |       ✅        |     ✅     |      ✅      |     ❌      |    ❌     |
-|          Anti XSS          |       ✅        |       ✅        |     ❌     |      ❌      |     ❌      |    ❌     |
-|  Custom (CSS/Header/HTML)  |       ✅        |       ✅        |     ✅     |      ✅      |     ❌      |    ❌     |
-|       Custom Search        |       ✅        |       ✅        |     ❌     |      ❌      |     ❌      |    ❌     |
-|        Leaderboards        |       ✅        |       ✅        |     ❌     |      ❌      |     ❌      |    ❌     |
-|       Health Options       |       ✅        |       ✅        |     ❌     |      ❌      |     ❌      |    ❌     |
-|    XChaCha20 Encryption    |       ✅        |       ⚠️        |     ❌     |      ❌      |     ❌      |    ❌     |
-|     Easy Translations      |       ✅        |       ✅        |     ❌     |      ❌      |     ❌      |    ❌     |
-|       Activity Logs        |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|          Web Logs          |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|   Auto Error Correction    |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|   Plugin System (Events)   |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|      Package Manager       |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|        Renew System        |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-| Mc Style Permission System |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|        2Factor Auth        |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|         Unit Tests         |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|        Self Backups        |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
-|       Announcements        |       ✅        |       ❌        |     ❌     |      ❌      |     ❌      |    ❌     |
+View the full roadmap [here](https://github.com/orgs/MythicalLTD/projects/5).
 
 ---
 
-You can find the roadmap at: https://github.com/orgs/MythicalLTD/projects/5
+## 🤝 Contributing
 
-## Contributing
+Contributions are always welcome! For guidelines on how to contribute, please see [CONTRIBUTING.md](CONTRIBUTING.md).
 
-Contributions are always welcome!
+---
 
-## Install (Only if you want to test it ;)
+## 🧪 Install (Only for Testing)
 
 ```bash
 bash <(curl https://raw.githubusercontent.com/MythicalLTD/MythicalDash/refs/heads/mythicaldash-v4/install.bash)
 ```
 
-## Serial Code:
+---
+
+## 📜 Serial Code
 
 ```bash
 1 490 650 284