Update README.md

This commit is contained in:
Braydon 2024-04-28 20:28:36 -04:00
parent 3a9737a44b
commit 9ad4ebb3d0
2 changed files with 18 additions and 6 deletions

@ -1,4 +1,4 @@
# Contributing
# 🛠️ Contributing
Made changes or improvements to Pelican4J? Consider opening a [pull request](https://git.rainnny.club/Rainnny/Pelican4J/pulls) to merge your changes into the project. Remember to stick with project conventions!
This project follows [Semantic Versioning](https://semver.org).

@ -11,21 +11,33 @@ A Java API wrapper for the [Pelican](https://pelican.dev) and [Pterodactyl](http
---
- [Installation](#installation)
# Table of Contents
- [Installation](#-installation)
- [Maven](#maven)
- [Gradle (Kotlin DSL)](#gradle-kotlin-dsl)
- [Usage](#usage)
- [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
`TODO`
```xml
<dependency>
<groupId>me.braydon</groupId>
<artifactId>Pelican4J</artifactId>
<version>VERSION</version>
</dependency>
```
### Gradle (Kotlin DSL)
`TODO`
```kt
implementation("me.braydon:Pelican4J:VERSION")
```
## Usage
## 🏃‍♂️ Getting Started
`TODO`
---