diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8f1807b..54babdb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -23,8 +23,8 @@ Fixes # (issue) - [ ] This pull request has been linked to the appropriate issue on GitHub. (Use the development section on the right.) - [ ] The code follows the style [guidlines](https://github.com/beanbeanjuice/cafeBot/blob/master/CONTRIBUTING.md). -- [ ] A self-review of the code was performed in GitHub. -- [ ] Appropriate comments were added in the code. +- [ ] A self-review of the code was performed on GitHub. +- [ ] Appropriate comments and javadocs were added to your code. - [ ] Appropriate changes have been made to the documentation. - [ ] Appropriate changes have been made to the `README.md` file. - [ ] No warnings are produced when the code is run. diff --git a/README.md b/README.md index 1e1ad36..1221901 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![wakatime](https://wakatime.com/badge/github/beanbeanjuice/Java-Kawaii-API-Wrapper.svg?style=for-the-badge)](https://wakatime.com/badge/github/beanbeanjuice/Java-Kawaii-API-Wrapper) [![CodeFactor](https://www.codefactor.io/repository/github/beanbeanjuice/java-kawaii-api-wrapper/badge?style=for-the-badge)](https://www.codefactor.io/repository/github/beanbeanjuice/java-kawaii-api-wrapper) -![GitHub release (latest by date)](https://img.shields.io/github/v/release/beanbeanjuice/Java-Kawaii-API-Wrapper?style=for-the-badge) +![Maven Central](https://img.shields.io/maven-central/v/com.beanbeanjuice/kawaii-api-wrapper?color=%23CBC3E3&style=for-the-badge)
@@ -55,11 +55,27 @@ # Getting Started -To add this bot to your server, follow these steps. +## Usage + +*For Anonymous Requests...* +```Java +KawaiiAPI kawaiiAPI = new KawaiiAPI(); +kawaiiAPI.GIF.getGIF("hug"); +``` + +*For Normal Requests...* +```Java +KawaiiAPI kawaiiAPI = new KawaiiAPI(TOKEN_HERE); +kawaiiAPI.GIF.getGIF("hug"); +``` + +Currently, the supported "prompts" are located [here](https://docs.kawaii.red/endpoints/gif). I have no control over the actual endpoint list. ## Installation -Make sure you replace VERSION with the appropriate version. +![Maven Central](https://img.shields.io/maven-central/v/com.beanbeanjuice/kawaii-api-wrapper?color=%23CBC3E3) + +Make sure you replace VERSION with the appropriate version specified above. For `Maven`, paste this into your `dependencies` section of your `pom.xml` file. ```XML diff --git a/pom.xml b/pom.xml index 56904b4..8d4f4e1 100644 --- a/pom.xml +++ b/pom.xml @@ -14,7 +14,7 @@ 16 UTF-8 UTF-8 - 1.1.0 + 1.1.1 diff --git a/src/main/java/com/beanbeanjuice/KawaiiAPI.java b/src/main/java/com/beanbeanjuice/KawaiiAPI.java index 10a0056..b407a06 100644 --- a/src/main/java/com/beanbeanjuice/KawaiiAPI.java +++ b/src/main/java/com/beanbeanjuice/KawaiiAPI.java @@ -4,10 +4,10 @@ import org.jetbrains.annotations.NotNull; /** - * A class used for the KawaiiAPI + * A class used for the {@link KawaiiAPI}. * * @author beanbeanjuice - * @since v1.0.0 + * @since 1.1.1 */ public class KawaiiAPI { @@ -15,11 +15,24 @@ public class KawaiiAPI { /** * Create a new {@link KawaiiAPI} object. - * @param token The {@link String token} for keeping track of statistics. Can be "anonymous". + * @param token The {@link String token} for keeping track of statistics. * @see Token * @see Kawaii API Documentation */ public KawaiiAPI(@NotNull String token) { + initialiseEndPoints(token); + } + + /** + * Create a new, anonymous, {@link KawaiiAPI} object. + * @see Token + * @see Kawaii API Documentation + */ + public KawaiiAPI() { + initialiseEndPoints("anonymous"); + } + + private void initialiseEndPoints(@NotNull String token) { GIF = new GifEndpoint(token); }