Pelican4J/README.md

[![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)
![Wakatime Hours](https://wakatime.rainnny.club/api/badge/Rainnny/interval:any/project:Pelican4J)
[![Discord](https://discord.com/api/guilds/827863713855176755/widget.png)](https://discord.gg/p9gzFE2bc6)

# 🦅 Pelican4J
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.

---

# Table of Contents
- [Installation](#-installation)
  - [Maven](#maven)
  - [Gradle (Kotlin DSL)](#gradle-kotlin-dsl)
- [Getting Started](#-getting-started)

---

## 🔬 Installation
Before getting started, you must add the dependency to your project.
Below you can find the dependency for both [Maven](#maven) and [Gradle](#gradle-kotlin-dsl).

### Maven
```xml
<dependency>
  <groupId>me.braydon</groupId>
  <artifactId>Pelican4J</artifactId>
  <version>VERSION</version>
</dependency>
```

### Gradle (Kotlin DSL)
```kt
implementation("me.braydon:Pelican4J:VERSION")
```

## 🏃‍♂️ Getting Started
`TODO`

---

## 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)