Add README.md

Update build.gradle
Add example

Author: Lezurex

.idea/gradle.xml

@@ -0,0 +1,61 @@
+# GitHub Version Checker
+
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/Lezurex/github-version-checker)
+![GitHub all releases](https://img.shields.io/github/downloads/Lezurex/github-version-checker/total)
+![GitHub](https://img.shields.io/github/license/Lezurex/github-version-checker)
+
+A java library for checking for new releases on GitHub
+
+## Download
+
+Gradle:
+```gradle
+maven {
+    url "https://repo.voxcrafter.dev/repository/maven-releases/"
+}
+
+dependencies {
+    implementation 'com.lezurex.githubversionchecker:1.0.0'
+}
+```
+
+Maven:
+```xml
+<dependency>
+  <groupId>com.lezurex</groupId>
+  <artifactId>github-version-checker</artifactId>
+  <version>1.0.0</version>
+  <scope>compile</scope>
+</dependency>
+
+<repository>
+  <id>voxcrafter-repo</id>
+  <url>https://repo.voxcrafter.dev/repository/maven-releases/</url>
+</repository>
+```
+
+## Usage
+```java
+public class Example {
+
+    public static void main(String[] args) {
+        ReleaseVersion currentVersion = new ReleaseVersion("v1.0.0");
+        GithubVersionChecker versionChecker = new GithubVersionChecker("Lezurex", "github-version-checker", currentVersion);
+
+        CheckResult result = versionChecker.check();
+        switch (result.getVersionState()) {
+            case NEWER:
+                System.out.println("You are on a development branch, aren't you?");
+                break;
+            case OUTDATED:
+                System.out.printf("Your current version is outdated! %s is available here: %s", result.getVersion(), result.getPageLink());
+                break;
+            case UP_TO_DATE:
+                System.out.println("Your current version is up to date!");
+                break;
+        }
+
+    }
+
+}
+```

.idea/jarRepositories.xml

@@ -1,14 +1,20 @@
 plugins {
     id 'java-library'
+    id 'maven-publish'
 }
 
 group 'com.lezurex'
-version '1.0'
+version '1.0.0'
 
 repositories {
     mavenCentral()
 }
 
+java {
+    withJavadocJar()
+    withSourcesJar()
+}
+
 dependencies {
     implementation 'com.google.code.gson:gson:2.8.7'
 
@@ -24,4 +30,50 @@ dependencies {
 
 test {
     useJUnitPlatform()
+}
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            artifactId = 'github-version-checker'
+            from components.java
+            versionMapping {
+                usage('java-api') {
+                    fromResolutionOf('runtimeClasspath')
+                }
+                usage('java-runtime') {
+                    fromResolutionResult()
+                }
+            }
+            pom {
+                name = 'Github Version Checker'
+                description = 'A java library for checking for new releases on GitHub'
+                url = 'https://github.com/Lezurex/github-version-checker'
+                licenses {
+                    license {
+                        name = "GNU General Public License v3.0"
+                        url = "https://www.gnu.org/licenses/gpl-3.0.txt"
+                    }
+                }
+            }
+        }
+    }
+    repositories {
+        maven {
+            name = "voxcrafter-repo"
+            def releasesRepoUrl = 'https://repo.voxcrafter.dev/repository/maven-releases/'
+            def snapshotsRepoUrl = 'https://repo.voxcrafter.dev/repository/maven-snapshots/'
+            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
+            credentials {
+                username = voxrepoUser
+                password = voxrepoPassword
+            }
+        }
+    }
+}
+
+javadoc {
+    if (JavaVersion.current().isJava9Compatible()) {
+        options.addBooleanOption('html5', true)
+    }
 }

.idea/uiDesigner.xml

@@ -0,0 +1,24 @@
+plugins {
+    id 'java'
+}
+
+group 'com.lezurex.github-version-checker'
+version '1.0.0'
+
+repositories {
+    mavenCentral()
+    maven {
+        url "https://repo.voxcrafter.dev/repository/maven-releases/"
+    }
+}
+
+dependencies {
+    implementation 'com.lezurex:github-version-checker:1.0.0'
+
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'
+}
+
+test {
+    useJUnitPlatform()
+}

README.md

@@ -0,0 +1,28 @@
+package com.lezurex.githubversionchecker.examples;
+
+import com.lezurex.githubversionchecker.CheckResult;
+import com.lezurex.githubversionchecker.GithubVersionChecker;
+import com.lezurex.githubversionchecker.ReleaseVersion;
+
+public class Example {
+
+    public static void main(String[] args) {
+        ReleaseVersion currentVersion = new ReleaseVersion("v1.0.0");
+        GithubVersionChecker versionChecker = new GithubVersionChecker("Lezurex", "github-version-checker", currentVersion);
+
+        CheckResult result = versionChecker.check();
+        switch (result.getVersionState()) {
+            case NEWER:
+                System.out.println("You are on a development branch, aren't you?");
+                break;
+            case OUTDATED:
+                System.out.printf("Your current version is outdated! %s is available here: %s", result.getVersion(), result.getPageLink());
+                break;
+            case UP_TO_DATE:
+                System.out.println("Your current version is up to date!");
+                break;
+        }
+
+    }
+
+}

build.gradle

@@ -1,2 +1,3 @@
 rootProject.name = 'github-version-checker'
+include 'examples'