From 9ad4ebb3d07a60891e85c95e4d577cd9af0866ab Mon Sep 17 00:00:00 2001 From: Rainnny7 Date: Sun, 28 Apr 2024 20:28:36 -0400 Subject: [PATCH] Update README.md --- CONTRIBUTING.md | 2 +- README.md | 22 +++++++++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e3d70c..2fe62e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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). \ No newline at end of file diff --git a/README.md b/README.md index 7fc669b..576cea0 100644 --- a/README.md +++ b/README.md @@ -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 + + me.braydon + Pelican4J + VERSION + +``` ### Gradle (Kotlin DSL) -`TODO` +```kt +implementation("me.braydon:Pelican4J:VERSION") +``` -## Usage +## 🏃‍♂️ Getting Started `TODO` ---