Merge remote-tracking branch 'origin/main'

1 files changed, 17 insertions, 3 deletions

diff --git a/README.md b/README.md
index 848c058..583d83a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
-# JHolodex
-A mega scuffed Java Holodex Wrapper (cuz i might need one someday)
-This is currently a work-in-progress
+# JHolodex 
+[![](https://jitpack.io/v/pinapelz/JHolodex.svg)](https://jitpack.io/#pinapelz/JHolodex)
+[![build](https://github.com/pinapelz/JHolodex/actions/workflows/maven.yml/badge.svg)](https://github.com/pinapelz/JHolodex/actions/workflows/maven.yml)
 
+
+A mega scuffed Java Holodex Wrapper (Currently a work in progress). Supports the GET Requests from [Holodex API](https://holodex.stoplight.io/). Objects are used to build queries if more than one path or parameter is used for the given request.
+
+## Usage
 ```java
 Holodex holodex = new Holodex("YOUR_API_KEY");
 Channel channel = holodex.getChannel("UC4WvIIAo89_AzGUh1AZ6Dkg");
@@ -27,4 +31,14 @@ System.out.println(anotherVideo.channel.name + " uploaded a video titled " + ano
   " on " + anotherVideo.published_at);
 ```
 
+## Download
+Maven
+```xml
+<dependency>
+    <groupId>com.github.pinapelz</groupId>
+    <artifactId>JHolodex</artifactId>
+    <version>VERSION_HERE</version>
+</dependency>
+```
+
 [Holodex License](https://docs.holodex.net/docs/holodex/8166fcec5dbe2-license)