aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md57
1 files changed, 38 insertions, 19 deletions
diff --git a/README.md b/README.md
index 9258d2af0..a7c00b495 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,50 @@
-
-
-<h1 align = "center">
- SkyHanni: Mod for Hypixel SkyBlock
+<h1 align="center">
+ SkyHanni: Mod for Hypixel SkyBlock
</h1>
+
<div align="center">
-[![discord badge](https://img.shields.io/discord/997079228510117908?label=discord&color=9089DA&logo=discord&style=for-the-badge)](https://discord.gg/skyhanni-997079228510117908)
-[![made with kotlin](https://img.shields.io/badge/Made%20With-Kotlin-orange?style=for-the-badge&logo=kotlin&logocolor=white)](https://kotlinlang.org/)
-[![downloads](https://img.shields.io/github/downloads/hannibal002/SkyHanni/total?label=downloads&color=208a19&logo=github&style=for-the-badge)](https://github.com/hannibal002/SkyHanni/releases)
+![sh_logo](https://github.com/hannibal002/SkyHanni/assets/24389977/2f52afa0-0330-434e-ba1c-f2affee96bc1)
+
+[![Discord](https://img.shields.io/discord/997079228510117908?label=discord&color=9089DA&logo=discord&style=for-the-badge)](https://discord.gg/skyhanni-997079228510117908)
+[![Made with Kotlin](https://img.shields.io/badge/Made%20With-Kotlin-orange?style=for-the-badge&logo=kotlin&logocolor=white)](https://kotlinlang.org/)
+[![Downloads](https://img.shields.io/github/downloads/hannibal002/SkyHanni/total?label=downloads&color=208a19&logo=github&style=for-the-badge)](https://github.com/hannibal002/SkyHanni/releases)
</div>
-SkyHanni is a Forge mod for Minecraft 1.8.9. It adds many features to Hypixel SkyBlock.
-The mod is filled with GUIs, extra chat messages, reminders, message hiders and entity highlighters.
-The majority of these features are centered around the Garden, Slayer, Bingo, Diana, and Rift.
+## What it does
+
+SkyHanni is a Forge mod for Minecraft 1.8.9 that adds many useful features to Hypixel SkyBlock. With SkyHanni, you'll get:
+
+* **Helpful GUIs:** Access important information at a glance.
+* **Extra Chat Messages:** Receive reminders and helpful tips.
+* **Message Hiders:** Control which messages you see in chat.
+* **Entity/Item Highlighters:** Focus on important mobs or items in the world/your inventory.
+* **[And much more!](docs/FEATURES.md)**
+
+SkyHanni is especially helpful when doing activities like farming, slayers, Bingo, Diana, fishing, or Rift.
+
+## Getting Started
+
+1. **Install:** Check out the [installation guide](docs/INSTALLING.md).
+2. **Set Up:** Type `/sh` or `/skyhanni` in-game to configure your settings.
+3. **Explore:** See all the features [here](docs/FEATURES.md).
+
+## Discord & Support
+
+Give feedback or just chat with others on our community Discord!
-We have a [tutorial](docs/INSTALLING.md)
-for how to download and install the mod.
+* **Bug Reports:** Use the `#bug-reports` channel.
+* **Feature Suggestions:** Use the `#suggestions` channel.
+* **General Chat:** Chat with other SkyHanni users in `#skyblock-general` channel.
-Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
+[Join the Discord](https://discord.gg/skyhanni-997079228510117908)
-[Here](docs/FEATURES.md) is a large list of all features.
+## Contributing
-For bug reports, feature requests, and other feedback, please visit
-our [Discord](https://discord.gg/skyhanni-997079228510117908).
+Interested in writing your own SkyHanni feature or fixing that one annoying bug yourself? Check out our [contributing guide](CONTRIBUTING.md) for more information.
-If you are interested in the technical side of SkyHanni, read
-the [Contributing Guide](CONTRIBUTING.md).
+---
-*Check out some other really cool 1.8.9 mods [here](https://sbmw.ca/mod-lists/skyblock-mod-list/)*
+**SkyHanni is part of an active modding community. Explore other useful mods [here](https://sbmw.ca/mod-lists/skyblock-mod-list/) to
+complete your SkyBlock setup!**