diff --git a/README.md b/README.md index e42a746..ca327a4 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# TradeMe \ No newline at end of file +# TradeMe + +[![TradeMe on SpigotMC](https://img.shields.io/badge/SpigotMC-TradeMe-orange)](https://www.spigotmc.org/resources/7544/) +[![GitHub issues](https://img.shields.io/github/issues/Zrips/TradeMe)](https://github.com/Zrips/TradeMe/issues) +[![Zrips website](https://img.shields.io/badge/website-zrips.net-blue)](https://www.zrips.net/) + +TradeMe is a premium Minecraft server plugin by Zrips for player-to-player trading through an inventory GUI. Players can trade items, money, experience, and additional values provided by supported integrations; an API is available for custom trade types. + +> [!NOTE] +> This repository currently serves as the public issue and feature-request tracker for TradeMe. It does not contain the plugin source, downloads, or build files. + +## Installation + +1. Obtain TradeMe from its [official SpigotMC resource page](https://www.spigotmc.org/resources/7544/). +2. Install TradeMe and a compatible version of [CMILib](https://www.spigotmc.org/resources/cmilib.87610/) in the server's `plugins` directory. +3. Restart the server and review the generated configuration before enabling optional integrations. + +Use the compatibility information and current documentation on the official resource page when selecting versions. Commands, permissions, configuration, and API usage are documented there as well. + +## Reporting an issue + +Search the [existing issues](https://github.com/Zrips/TradeMe/issues) before opening a new one. Please include: + +- TradeMe, CMILib, Minecraft, and server-software versions; +- clear reproduction steps and the expected and actual behavior; +- relevant errors or logs inside a code block; and +- integration names and versions when the problem involves another plugin. + +Remove passwords, tokens, addresses, and other private information from logs. For a possible duplication exploit or another security-sensitive problem, contact Zrips privately (PM on Spigot, or DM on Discord) before publishing reproduction details. + +## Links + +- [Download and documentation](https://www.spigotmc.org/resources/7544/) +- [Issue tracker](https://github.com/Zrips/TradeMe/issues) +- [CMILib dependency](https://www.spigotmc.org/resources/cmilib.87610/) +- [Zrips website](https://www.zrips.net/)