Worked the readme

Author: CaptainSly

build.gradle.kts

@@ -4,6 +4,9 @@ plugins {
     `java-library`
 }
 
+group = "com.spireprod"
+version = "0.1.10-Talos"
+
 repositories {
     // Use Maven Central for resolving dependencies.
     mavenCentral()
@@ -13,13 +16,16 @@ repositories {
 }
 
 dependencies {
-	implementation("com.googlecode.lanterna:lanterna:3.1.2")
+	api("com.googlecode.lanterna:lanterna:3.1.2")
 }
 
 // Apply a specific Java toolchain to ease working on different environments.
 java {
     toolchain {
         languageVersion = JavaLanguageVersion.of(21)
     }
+    
+    withJavadocJar()
+    withSourcesJar()
 }
 

readme.md

@@ -1,10 +1,75 @@
-# Console Java Engine
+# Console Java Engine - Version 0.1.10-Talos
 
 The Console Java Engine is based off of JavidX9's PixelGameEngine.
 
-Uses Lanterna to emulate a terminal.
+Uses Lanterna to emulate a terminal, also comes with a Pair class that is a basic copy of C++s pair class.
 
-Currently has a flickering bug that can probably be fixed
-Check the ConsoleFPS class for an example of how to use the program. It is a port of JavidX9's raycaster from his video Code-It-Yourself. First Person Shooter (Quick and Simple C++)
 
-Also comes with a Pair class that is a basic copy of C++s pair class.
+## How to use
+
+To use CJE, include it in your project, then create a class and extend the `ConsoleJavaEngine`. It provides a Skeleton for your project and also provides protected methods to write to the screen. 
+
+```Java
+
+import com.googlecode.lanterna.input.KeyStroke;
+import com.spireprod.cje.ConsoleJavaEngine;
+
+public class Adventure extends ConsoleJavaEngine {
+
+	public Adventure() {
+		super("Adventure", 80, 24);
+	}
+
+	@Override
+	protected void onGameCreate() {
+
+	}
+
+	@Override
+	protected void onGameUpdate(float deltaTime) {
+
+	}
+
+	@Override
+	protected void onGameInput(float deltaTime, KeyStroke keyStroke) {
+
+	}
+
+	@Override
+	protected void onGameRender(float alpha) {
+
+	}
+
+	public static void main(String[] args) {
+		Adventure venture = new Adventure();
+		venture.run();
+	}
+
+}
+
+```
+
+
+### Jitpack
+[![](https://jitpack.io/v/CaptainSly/ConsoleJavaEngine.svg)](https://jitpack.io/#CaptainSly/ConsoleJavaEngine)
+
+ConsoleJavaEngine is available through [Jitpack](https://jitpack.io). Here's what you want to use:
+
+```gradle
+
+	dependencyResolutionManagement {
+		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+		repositories {
+			mavenCentral()
+			maven { url = uri("https://jitpack.io") }
+		}
+	}
+	
+	dependencies {
+	        implementation("com.github.CaptainSly:ConsoleJavaEngine:{VERSION}")
+	}
+```
+
+## Known Bugs
+
+Currently has a flickering bug.

src/main/java/com/spireprod/cje/ConsoleJavaEngine.java

@@ -21,9 +21,9 @@
 public abstract class ConsoleJavaEngine {
 
 	protected String PIXEL_BLOCK = "\u2588";
+	protected String PIXEL_SHADE = "\u2591";
 	protected String PIXEL_SHADE_FULL = "\u2593";
 	protected String PIXEL_SHADE_HALF = "\u2592";
-	protected String PIXEL_SHADE = "\u2591";
 
 	protected Terminal terminal;
 	protected TextGraphics termGraphics;
@@ -37,7 +37,7 @@ public abstract class ConsoleJavaEngine {
 	private final int targetFPS = 60;
 	private final long optimalTime = (long) (1E9f / targetFPS);
 
-	public static final String CJE_VERSION = "0.1.5-Talos";
+	public static final String CJE_VERSION = "0.1.10-Talos";
 
 	public ConsoleJavaEngine(String title, int width, int height) {
 		DefaultTerminalFactory defaultTermFactory = new DefaultTerminalFactory();