diff --git a/README.md b/README.md index 18ac5d5..caa550d 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,46 @@
-EpicEnchants + # EpicEnchants +**Unlock the potential of your weapons, tools and armor by making your own custom enchants** +**using this highly customizable and versatile advanced enchantment system.** -**Unlock the potential of your weapons, tools and armor by making your own custom enchants -using this highly customizable and versatile advanced enchantment system.** - -[![Discord](https://img.shields.io/discord/293212540723396608?color=7289DA&label=Discord&logo=discord&logoColor=7289DA)](https://discord.gg/songoda) -[![Patreon](https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white)](https://www.patreon.com/join/songoda) +[![Discord][Discord shield]][Discord invite] +[![Patreon][Patreon shield]][Patreon page]
-[![Latest version](https://img.shields.io/github/v/tag/songoda/EpicEnchants?include_prereleases&label=Latest&logo=github&labelColor=black)](https://songoda.com/marketplace/product/67) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=songoda_EpicEnchants&metric=alert_status)](https://sonarcloud.io/dashboard?id=songoda_EpicEnchants) -[![GitHub last commit](https://img.shields.io/github/last-commit/songoda/EpicEnchants?label=Last+commit)](https://github.com/songoda/EpicEnchants/commits) -
-[![bStats Servers](https://img.shields.io/bstats/servers/5287?label=Servers)](https://bstats.org/plugin/bukkit/EpicEnchants/5287) +[![Latest version][Latest version shield]][Marketplace page] +[![bStats Servers][bStats shield]][bStats page]
-## Table of Contents -* [Introduction](#introduction) -* [Marketplace](#marketplace) -* [Documentation](#documentation) -* [Support](#support) -* [Suggestions](#suggestions) - -## Introduction - -`// TODO: Write an introduction` - -## Marketplace - -You can visit [our marketplace](https://songoda.com/marketplace/product/67) to download EpicEnchants as well as take a +## Download (Marketplace) +You can visit [our marketplace][Marketplace page] to download EpicEnchants as well as take a look at many other fantastic plugins which are sure to catch your eye. ## Documentation - -You can find all the information about EpicAnchors, including dependencies, commands, permissions and incompatible -plugins on [our wiki](https://wiki.songoda.com/Epic_Enchants). +You can find all the information about EpicEnchants, including dependencies, commands, permissions and incompatible +plugins on [our wiki][Plugin wiki]. Feel free to also contribute to the wiki as a way to help others in the community with using the plugin. ## Support - -If you encounter any issues while using the plugin, feel free to create a ticket -on [our support desk](https://support.songoda.com). +If you encounter any issues while using the plugin, feel free to contact us on +[our Discord server][Discord invite]. ## Suggestions - For suggestions about features you think should be added to the plugin to increase its functionality, feel free to -create a thread over on [our feedback site](https://feedback.songoda.com). +create a thread over on [our Discord server][Discord invite]. + + +[Marketplace page]: https://craftaro.com/marketplace/product/67 +[Plugin wiki]: https://wiki.craftaro.com/index.php/Epic_Enchants +[Patreon page]: https://www.patreon.com/join/songoda +[Discord invite]: https://discord.gg/craftaro +[bStats page]: https://bstats.org/plugin/bukkit/EpicEnchants/5287 + +[Patreon shield]: https://img.shields.io/badge/-Support_us_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white +[Discord shield]: https://img.shields.io/discord/293212540723396608?color=5865F2&label=Discord&logo=discord&logoColor=5865F2 +[bStats shield]: https://img.shields.io/bstats/servers/5287?label=Servers +[Latest version shield]: https://img.shields.io/badge/dynamic/xml?style=flat&color=blue&logo=github&logoColor=white&label=Latest&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcraftaro%2FEpicEnchants%2Fmaster%2Fpom.xml&query=%2F*%5Blocal-name()%3D'project'%5D%2F*%5Blocal-name()%3D'version'%5D