aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhannibal2 <24389977+hannibal002@users.noreply.github.com>2024-09-07 06:53:48 +0200
committerGitHub <noreply@github.com>2024-09-07 06:53:48 +0200
commita4fde679f7a980a2ab86180e475e2ebc76bdd9f0 (patch)
tree79c6fac1605adfe82034565af026f0ebb8e0692e
parent987fc85d379a6dee461778ebd75ff0fba3a3e8b8 (diff)
downloadskyhanni-a4fde679f7a980a2ab86180e475e2ebc76bdd9f0.tar.gz
skyhanni-a4fde679f7a980a2ab86180e475e2ebc76bdd9f0.tar.bz2
skyhanni-a4fde679f7a980a2ab86180e475e2ebc76bdd9f0.zip
Docs: Readme updates (#2458)
-rw-r--r--README.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/README.md b/README.md
index a7c00b495..07bf336a1 100644
--- a/README.md
+++ b/README.md
@@ -14,19 +14,19 @@
## 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:
+SkyHanni is a Forge mod for Minecraft 1.8.9 that adds many useful features to [Hypixel SkyBlock](https://wiki.hypixel.net/Main_Page). With SkyHanni you have access to:
-* **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)**
+* **Helpful GUIs:** View important information at a glance.
+* **Extra Chat Messages:** Receive reminders and tips at the right moment.
+* **Object Highlighters:** Focus on important items in inventories or highlight mobs in the world.
+* **Highly Customizeable Displays:** Personalise your Scoreboard, Tab List or chat format.
+* [And **much** more!](docs/FEATURES.md)
-SkyHanni is especially helpful when doing activities like farming, slayers, Bingo, Diana, fishing, or Rift.
+SkyHanni is especially useful when doing farming, slayers, Bingo, Diana, fishing, Rift or mining.
## Getting Started
-1. **Install:** Check out the [installation guide](docs/INSTALLING.md).
+1. **Install:** Follow 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).
@@ -34,17 +34,17 @@ SkyHanni is especially helpful when doing activities like farming, slayers, Bing
Give feedback or just chat with others on our community Discord!
-* **Bug Reports:** Use the `#bug-reports` channel.
-* **Feature Suggestions:** Use the `#suggestions` channel.
-* **General Chat:** Chat with other SkyHanni users in `#skyblock-general` channel.
+* **Bug Reports:** Use the `#bug-reports` channel when you find broken features (please check out `#faq` and `#known-bugs`).
+* **Quick Help** Ask in `#support` for questions and problems with the the mod or Minecraft in general.
+* **Feature Suggestions:** Feel fre to tell your ideas in `#suggestions` channel for new features and improvements to the mod. (Don't copy from existing mods or break Hypixel rules).
+* **General Chat:** Chat with other SkyHanni users in `#skyblock-general` channel about the game.
-[Join the Discord](https://discord.gg/skyhanni-997079228510117908)
+**[Join the Discord!](https://discord.gg/skyhanni-997079228510117908)**
## Contributing
-Interested in writing your own SkyHanni feature or fixing that one annoying bug yourself? Check out our [contributing guide](CONTRIBUTING.md) for more information.
+Are you interested in writing your own SkyHanni feature? Do you want to fix that one annoying bug yourself? Check out our [contributing guide](CONTRIBUTING.md) for more information!
---
-**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!**
+**SkyHanni is part of an active modding community. Explore other useful mods [here](https://sbmw.ca/mod-lists/skyblock-mod-list/) for even more SkyBlock features!**