aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPinapelz <donaldshan1@outlook.com>2023-04-05 16:03:22 -0700
committerGitHub <noreply@github.com>2023-04-05 16:03:22 -0700
commitedcfd9cd38f6a297533a282259011711c971f721 (patch)
tree3c9dd39e14700633b99e2248869545cddd8839b4 /README.md
parentcd847c8231cc84e30981a811e7dbe137e40aef0f (diff)
Updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 16 insertions, 3 deletions
diff --git a/README.md b/README.md
index 848c058..f55bfaa 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,10 @@
-# 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)
+
+A mega scuffed Java Holodex Wrapper (Currentlya work in progress). Currently 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 +30,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)
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage