From 05a1d5b2458cae4897455b66bd71d3fbc80fd0a7 Mon Sep 17 00:00:00 2001
From: epiard13 <epiard@reloadly.com>
Date: Thu, 11 Mar 2021 03:56:20 -0500
Subject: [PATCH] :lipstick: Cleanup + add plugins versions & update readme

---
 README.md                                     | 25 +------------------
 .../sdk/core/internal/net/ServiceAPI.java     |  2 ++
 .../reloadly/sdk/core/net/ProxyOptions.java   |  2 ++
 pom.xml                                       | 11 +++++++-
 4 files changed, 15 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 9e3a4cc..07a464f 100644
--- a/README.md
+++ b/README.md
@@ -28,30 +28,7 @@ your [Reloadly APIs credentials][api-credentials-help].
 
 To run the SDK you will need **Java 1.8+**
 
-## Using the SDK
-
-### Gradle users
-
-Add the dependencies to your project's build file:
-
-```groovy
-implementation "software.reloadly:java-sdk:1.0.0"
-```
-
-### Maven users
-
-Add this dependency to your project's POM:
-
-```xml
-
-<dependency>
-    <groupId>software.reloadly</groupId>
-    <artifactId>java-sdk</artifactId>
-    <version>1.0.0</version>
-</dependency>
-```
-
-### Alternatives
+## Using the SDK Modules
 
 The SDK is made up of several modules such as **Authentication, Airtime, etc...**, you can alternatively add
 dependencies for the specific services you use only. For example : Authentication & Airtime
diff --git a/java-sdk-core/src/main/java/software/reloadly/sdk/core/internal/net/ServiceAPI.java b/java-sdk-core/src/main/java/software/reloadly/sdk/core/internal/net/ServiceAPI.java
index 298da41..8b3c927 100644
--- a/java-sdk-core/src/main/java/software/reloadly/sdk/core/internal/net/ServiceAPI.java
+++ b/java-sdk-core/src/main/java/software/reloadly/sdk/core/internal/net/ServiceAPI.java
@@ -40,7 +40,9 @@ public ServiceAPI(String clientId, String clientSecret, String accessToken,
     /**
      * Retrieve a new API access token to use on new calls.
      * This is useful when the token is about to expire or already has.
+     *
      * @param request - The request to refresh the token for
+     * @throws ReloadlyException - Error captured when executing an http request to the Reloadly Server
      */
     public abstract void refreshAccessToken(Request<?> request) throws ReloadlyException;
 
diff --git a/java-sdk-core/src/main/java/software/reloadly/sdk/core/net/ProxyOptions.java b/java-sdk-core/src/main/java/software/reloadly/sdk/core/net/ProxyOptions.java
index c149ab0..3997218 100644
--- a/java-sdk-core/src/main/java/software/reloadly/sdk/core/net/ProxyOptions.java
+++ b/java-sdk-core/src/main/java/software/reloadly/sdk/core/net/ProxyOptions.java
@@ -21,6 +21,8 @@ public class ProxyOptions {
     /**
      * Builds a new instance using the given Proxy.
      * The Proxy will not have authentication unless {@link #basicAuthentication} is set.
+     *
+     * @param proxy - The proxy setting
      */
     public ProxyOptions(Proxy proxy) {
         Asserter.assertNotNull(proxy, "proxy");
diff --git a/pom.xml b/pom.xml
index 2c01a76..01093ca 100644
--- a/pom.xml
+++ b/pom.xml
@@ -41,7 +41,7 @@
     <scm>
         <connection>scm:git:https://github.com/reloadly/reloadly-sdk-java.git</connection>
         <developerConnection>scm:git:git@github.com:reloadly/reloadly-sdk-java.git</developerConnection>
-        <url>https://github.com/reloadly/reloadly-sdk-java</url>
+        <url>https://github.com/reloadly/reloadly-sdk-java/tree/main</url>
     </scm>
 
     <properties>
@@ -57,11 +57,15 @@
         <maven.compiler.target>1.8</maven.compiler.target>
         <commons-codec.version>1.15</commons-codec.version>
         <junit-jupiter.version>5.7.1</junit-jupiter.version>
+        <maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
         <jackson-databind.version>2.12.1</jackson-databind.version>
+        <maven-source-plugin.version>3.2.1</maven-source-plugin.version>
+        <maven-javadoc-plugin.version>3.2.0</maven-javadoc-plugin.version>
         <jacoco-maven-plugin.version>0.8.6</jacoco-maven-plugin.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
         <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
+        <google-code-findbugs-annotations.version>3.0.1</google-code-findbugs-annotations.version>
     </properties>
 
     <dependencies>
@@ -100,6 +104,11 @@
             <artifactId>maven-model</artifactId>
             <version>${maven-model.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>annotations</artifactId>
+            <version>${google-code-findbugs-annotations.version}</version>
+        </dependency>
         <dependency>
             <groupId>com.squareup.okhttp3</groupId>
             <artifactId>mockwebserver</artifactId>