Update README.md

Author: ryderbelserion

.github/workflows/sync.yml

@@ -5,7 +5,7 @@ on:
 
   push:
     paths:
-      - 'description.md'   # Triggers for changes to this specific file
+      - 'README.md'   # Triggers for changes to this specific file
 
 jobs:
   sync:

README.md

@@ -2,61 +2,43 @@
 
 ![CrazyAuctions](https://raw.githubusercontent.com/Crazy-Crew/Branding/main/crazyauctions/banner/webp/banner.webp)
 
-[![Contributors][contributors-shield]][contributors-url]
-[![Forks][forks-shield]][forks-url]
-[![Stargazers][stars-shield]][stars-url]
-[![Issues][issues-shield]][issues-url]
-[![MIT License][license-shield]][license-url]
-[![CodeFactor](https://www.codefactor.io/repository/github/crazy-crew/crazyauctions/badge)](https://www.codefactor.io/repository/github/crazy-crew/crazyauctions)
-
-<big>**Auction off your items in style!**</big>
-
-<big>**Quick Links**</big><br>
-[Request Features](https://github.com/Crazy-Crew/CrazyAuctions/issues)<br>
-[Documentation](https://docs.crazycrew.us/docs/mods/crazyauctions)<br>
-[Developer API](https://docs.crazycrew.us/mods/crazyauctions/dev/)<br>
-[Report Bugs](https://github.com/Crazy-Crew/CrazyAuctions/issues)<br>
-[Trello Board](https://trello.com/b/B9exh23d/crazyauctions)
-
-<big>**Supported Platforms**</big><br>
-[![paper software](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/paper_vector.svg)](https://papermc.io/)
-[![purpur software](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/purpur_vector.svg)](https://purpurmc.org/)
-
-<big>**Initial Plugin Setup**</big><br>
-CrazyAuctions as first install will come with a set of default files such as `config.yml`, `messages.yml`
-You can simply edit these files, and configure the looks and settings then do `/crazyauctions reload`<br>
-
-![Features Banner](https://raw.githubusercontent.com/Crazy-Crew/Branding/main/crazyauctions/banner/webp/features.webp)<br>
-**Selling/buying/bidding items with ease.**<br>
-**Easy to use configurations.**<br>
-**Max/min bidding/buying.**<br>
-**Customizable category selector.**<br>
-**Blacklist items you don't want to be auctioned off.**<br>
-**Cancel auctions & retrieve the item afterward.**<br>
-**And much more!**<br>
-
-![Support Banner](https://raw.githubusercontent.com/Crazy-Crew/Branding/main/crazyauctions/banner/webp/support.webp)<br>
-Are you confused about something? Hop by the Discord and you might just get an answer!<br>
-Please head to [crazy-auctions](https://discord.com/channels/182615261403283459/1178545378564509786) with your question and do not cross post.<br>
-
-<details>
-<summary>Support Checklist</summary>
-
-Please check to make sure that your question wasn't asked before, You can use `Ctrl+F` on Discord to look for past conversations.<br>
-Describe your issue in detail, Don't just make it a bread crumb trail that has to be questioned out of you.<br>
-Plugin Version i.e. `CrazyAuctions 3.3` **LATEST DOES NOT COUNT**<br>
-Server Version & Server Type i.e. `Paper 1.21.1` or `Purpur 1.21.1` **LATEST DOES NOT COUNT**<br>
-Send any console errors or files you have through https://mclo.gs/ - (We don't own the website, You have to copy the link and send it.)<br>
-</details>
+[![][discord-shield]][discord-url]
+[![][contributors-shield]][contributors-url]
+[![][forks-shield]][forks-url]
+[![][stars-shield]][stars-url]
+[![][issues-shield]][issues-url]
+[![][license-shield]][license-url]
+
+</div></center>
+
+## Installation
+1) Download the update from modrinth/hangar for your version of Minecraft.
+    1) Note, Any version that is not the newest version of Minecraft is not supported.
+2) You must be using at least https://papermc.io
+3) The file you downloaded goes in the `plugins` folder.
+4) Restart the server.
+5) Run /crazyauctions
+6) View the documentation @ https://docs.crazycrew.us/mods/crazyenvoys/
+
+## Contributing
+- https://docs.crazycrew.us/mods/crazyauctions/contributing/
+
+## Support
+All support for the plugin is provided on Discord! If a question cannot be answered on the wiki, The next best place is to ask it in the Discord.
 
 <!--[![Discord](https://discord.com/api/guilds/182615261403283459/widget.png?style=banner2)](https://discord.gg/badbones-s-live-chat-182615261403283459)<br>-->
 [![Discord Invite Button](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg)](https://discord.gg/badbones-s-live-chat-182615261403283459)
-</div>
 
-![CrazyAuctions Statistics](https://bstats.org/signatures/bukkit/CrazyAuctions.svg)
-</center>
+## Data Collection
+We collect anonymous statistics on how the plugin is used at https://bstats.org/plugin/bukkit/CrazyAuctions/4624 and is visible to the public.
+If you do not want this anonymous data sent, You currently have to go to the `bStats` folder, and set that to false.
+
+<hr>
+
+## Apex Hosting (ad)
+We're sponsored by Apex Hosting, Click [here](https://billing.apexminecrafthosting.com/aff.php?aff=5511) to get 25% off your first purchase with the code `APEX25` at checkout for Minecraft servers, Satisfactory servers, and more!
 
-[contributors-shield]: https://img.shields.io/github/contributors/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
+[contributors-shield]: https://img.shields.io/github/contributors-anon/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
 [contributors-url]: https://github.com/Crazy-Crew/CrazyAuctions/graphs/contributors
 [forks-shield]: https://img.shields.io/github/forks/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
 [forks-url]: https://github.com/Crazy-Crew/CrazyAuctions/network/members
@@ -65,4 +47,6 @@ Send any console errors or files you have through https://mclo.gs/ - (We don't o
 [issues-shield]: https://img.shields.io/github/issues/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
 [issues-url]: https://github.com/Crazy-Crew/CrazyAuctions/issues
 [license-shield]: https://img.shields.io/github/license/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
-[license-url]: https://github.com/Crazy-Crew/CrazyAuctions/blob/main/LICENSE
+[license-url]: https://github.com/Crazy-Crew/CrazyAuctions/blob/main/LICENSE
+[discord-shield]: https://img.shields.io/discord/182615261403283459.svg?label=discord&logo=discord
+[discord-url]: https://discord.gg/badbones-s-live-chat-182615261403283459

buildSrc/src/main/kotlin/publish/modrinth-plugin.gradle.kts

@@ -21,7 +21,7 @@ modrinth {
 
     loaders.addAll(rootProject.property("project_platforms").toString().split(",").map { it.trim() })
 
-    syncBodyFrom = rootProject.file("description.md").readText(Charsets.UTF_8)
+    syncBodyFrom = rootProject.file("README.md").readText(Charsets.UTF_8)
 
     autoAddDependsOn = false
     detectLoaders = false