diff --git a/README.md b/README.md index a7c277b..53a8835 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ +[![MIT License](https://img.shields.io/badge/License-MIT-limegreen.svg?style=plastic)](https://choosealicense.com/licenses/mit) +[![Maven Publish Workflow](https://git.rainnny.club/Rainnny/Pelican4J/actions/workflows/maven-publish.yml/badge.svg)](./actions?workflow=maven-publish.yml) + # Pelican4J -A Java API wrapper for the Pelican/Pterodactyl panel API. \ No newline at end of file +A Java API wrapper for the [Pelican](https://pelican.dev) and [Pterodactyl](https://pterodactyl.io) panel API. + +> [!IMPORTANT] +> This API is currently a WIP and is not yet complete. + +--- + +- [Installation](#installation) + - [Maven](#maven) + - [Gradle (Kotlin DSL)](#gradle-kotlin-dsl) + +--- + +## Installation +### Maven +### Gradle (Kotlin DSL) + +--- + +## 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) \ No newline at end of file