diff --git a/README.md b/README.md new file mode 100644 index 0000000..e749a8c --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# FlexLib + +Java Wrapper for FlexPlex API + +## Maven + +```xml + + jitpack.io + https://jitpack.io + + + + fi.jonttu.git.FlexPlex + FlexLib + Version + +``` + +### Dependencies + +```xml + + com.neovisionaries + nv-websocket-client + 2.14 + + + com.google.code.gson + gson + 2.8.9 + +``` + +## Example + +```java +// Instantiate FlexLib, this should be done only once and instance saved. +final FlexLib flexLib = new FlexLib("token", Logger.getGlobal()); + +// Get friends API if its available +final Optional playerFriends = getPlayerFriends("a2a20f04-b722-4192-b184-8e41f1080ead"); +if (playerFriends.isPresent()) { + final Set friends = playerFriends.getFriends(); +} + +// Disables FlexLib +flexLib.disable(); +``` diff --git a/pom.xml b/pom.xml index 0e7e1f5..52613f7 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,12 @@ fi.flexplex lib 1.0.0 - FlexConnect + FlexLib + + 17 + 17 + 17 + ${project.name}-${project.version} @@ -13,8 +18,8 @@ maven-compiler-plugin 3.7.0 - 16 - 16 + 17 + 17 diff --git a/src/main/java/fi/flexplex/lib/FlexLib.java b/src/main/java/fi/flexplex/lib/FlexLib.java index f306a5d..72943a5 100644 --- a/src/main/java/fi/flexplex/lib/FlexLib.java +++ b/src/main/java/fi/flexplex/lib/FlexLib.java @@ -87,6 +87,9 @@ public final class FlexLib { return Optional.of(pFriends); } + /** + * Disableds FlexLib API instance + */ public void disable() { if (this.webSocketClient != null) { this.webSocketClient.disable();