Improved documentation, (#120)

dependency-reduced-pom.xml

@@ -4,7 +4,7 @@
   <groupId>io.github.ithotl</groupId>
   <artifactId>PlayerStats</artifactId>
   <name>PlayerStats</name>
-  <version>1.7.2</version>
+  <version>1.8</version>
   <description>Statistics Plugin</description>
   <url>https://www.spigotmc.org/resources/playerstats.102347/</url>
   <developers>
@@ -107,7 +107,6 @@
         <executions>
           <execution>
             <id>attach-sources</id>
-            <phase>deploy</phase>
             <goals>
               <goal>jar-no-fork</goal>
             </goals>
@@ -120,7 +119,6 @@
         <executions>
           <execution>
             <id>sign-artifacts</id>
-            <phase>deploy</phase>
             <goals>
               <goal>sign</goal>
             </goals>
@@ -133,7 +131,6 @@
         <executions>
           <execution>
             <id>attach-javadocs</id>
-            <phase>deploy</phase>
             <goals>
               <goal>jar</goal>
             </goals>

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.ithotl</groupId>
     <artifactId>PlayerStats</artifactId>
-    <version>1.7.2</version>
+    <version>1.8</version>
 
     <name>PlayerStats</name>
     <description>Statistics Plugin</description>

src/main/java/com/artemis/the/gr8/playerstats/api/PlayerStats.java

@@ -30,6 +30,15 @@ public interface PlayerStats {
         return Main.getPlayerStatsAPI();
     }
 
+    /**
+     * Gets the current version of PlayerStatsAPI.
+     * Use this method to ensure the correct version of
+     * PlayerStats is running on the server before
+     * accessing further API methods, to prevent
+     * <code>ClassDefNotFoundExceptions</code>.
+     *
+     * @return the version of PlayerStatsAPI present on the server
+     */
     default String getVersion() {
         return "1.8";
     }

src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
 main: com.artemis.the.gr8.playerstats.Main
 name: PlayerStats
-version: 1.7.2
+version: 1.8
 api-version: 1.13
 description: adds commands to view player statistics in chat
 author: Artemis_the_gr8