Merge remote-tracking branch 'origin/main'

3 files changed, 39 insertions, 4 deletions

diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
index 3bf28e8..5383bf9 100644
--- a/.github/workflows/maven.yml
+++ b/.github/workflows/maven.yml
@@ -6,7 +6,7 @@
 # separate terms of service, privacy policy, and support
 # documentation.
 
-name: Java CI with Maven
+name: build
 
 on:
   push:
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e7a97fb
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Pinapelz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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)