RESTfulMC/README.md
2024-04-15 05:56:53 -07:00

42 lines
1.8 KiB
Markdown

[![Discord](https://discord.com/api/guilds/827863713855176755/widget.png)](https://discord.gg/p9gzFE2bc6)
![Wakatime Hours](https://wakatime.rainnny.club/api/badge/Rainnny/interval:any/project:RESTfulMC)
[![Deploy API Workflow](https://git.rainnny.club/Rainnny/RESTfulMC/actions/workflows/deploy-api.yml/badge.svg)](./actions?workflow=deploy-api.yml)
[![Deploy Lib Workflow](https://git.rainnny.club/Rainnny/RESTfulMC/actions/workflows/publish-js-sdk.yml/badge.svg)](./actions?workflow=publish-js-sdk.yml)
# RESTfulMC
A simple, yet useful RESTful API for Minecraft utilizing Springboot.
---
### Table of Contents
- [Getting Started](#getting-started)
- [Wiki](#wiki)
- [Swagger API](#swagger-api)
- [SDKs](#)
- [JavaScript](./JS-SDK)
- [Contributing](#contributing)
---
## Getting Started
### Wiki
Hi there! Looking for usage? View the [Wiki](https://git.rainnny.club/Rainnny/RESTfulMC/wiki) for more information!
### Swagger API
View the [Swagger API Docs](https://mc.rainnny.club/swagger-ui.html) for easy testing!
![Swagger Logo](https://cdn.rainnny.club/UoeVQF7wYGg4.png)
## Contributing
Made changes or improvements to RESTfulMC? Consider opening a [pull request](https://git.rainnny.club/Rainnny/RESTfulMC/pulls) to merge your changes into the project. Remember to stick with project conventions!
This project follows [Semantic Versioning](https://semver.org).
---
## YourKit
YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications.
YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler), [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler), and [YourKit YouMonitor](https://www.yourkit.com/youmonitor).
![Yourkit Logo](https://www.yourkit.com/images/yklogo.png)