Create README.md

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..848c058
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# JHolodex
+A mega scuffed Java Holodex Wrapper (cuz i might need one someday)
+This is currently a work-in-progress
+
+```java
+Holodex holodex = new Holodex("YOUR_API_KEY");
+Channel channel = holodex.getChannel("UC4WvIIAo89_AzGUh1AZ6Dkg");
+System.out.println(channel.name + " is a member of " + channel.org + " and has " + channel.suborg + " as a suborg");
+
+LiveVideoQueryBuilder liveVideoQuery = new LiveVideoQueryBuilder().setStatus("live").setOrg("Hololive");
+List<Video> currentlyLiveVideos = holodex.getLiveVideos(liveVideoQuery);
+System.out.println("Currently there are " + currentlyLiveVideos.size() + " livestreams on going in Hololive");
+
+for (Video video : currentlyLiveVideos) {
+    System.out.println(video.channel.name + " is currently live with " + video.live_viewers + " views");
+}
+
+ChannelQueryBuilder channelQuery = new ChannelQueryBuilder();
+channelQuery.setOrg("Nijisanji");
+channelQuery.setLimit(75);
+List<Channel> nijisanjiMembers = holodex.getChannels(channelQuery);
+
+VideoQueryBuilder vidoeQuery = new VideoQueryBuilder();
+vidoeQuery.setVideoId("9-O_IWM3184");
+Video anotherVideo = holodex.getVideo(new VideoQueryBuilder().setVideoId("9-O_IWM3184").setLang("en"));
+System.out.println(anotherVideo.channel.name + " uploaded a video titled " + anotherVideo.title +
+  " on " + anotherVideo.published_at);
+```
+
+[Holodex License](https://docs.holodex.net/docs/holodex/8166fcec5dbe2-license)