Clean-up README and misc gradle stuff

Author: NickAcPT

README.md

@@ -1,32 +1,75 @@
 # Patchify
 
-Tool used to manage/automate code projects that require source-code patching.
+Tool used to manage/automate code projects that require source-code patching. This project was inspired by the tool used
+by [PaperMC](https://github.com/PaperMC/Paper).
 
-This project was inspired by the tool used by [PaperMC](https://github.com/PaperMC/Paper).
+## Gradle Plugin
 
-# Example
+The Gradle plugin is used to automatically manage the source-code patching process for projects that use Gradle without
+requiring manual use of the cli tool.
+
+To use the Gradle plugin, add the following to your settings.gradle.kts file:
+
+```kotlin
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+        maven("https://maven.quiltmc.org/repository/release/")
+        maven("https://raw.githubusercontent.com/NickAcPT/LightCraftMaven/main/")
+    }
+}
+```
+
+Now that the required plugin repositories have been added, Gradle can now find the plugin. To add it to your project,
+add the following to your build.gradle.kts file:
+
+```kotlin
+plugins {
+    id("io.github.nickacpt.patchify.gradle") version "2.1.0-SNAPSHOT"
+}
+```
+
+Then you can define the patchify configuration in your build.gradle.kts file:
+
+```kotlin
+patchify {
+    projectWorkspace(/* Name */ "Api", /* Project */ project(":sample-api")) {
+        initializer {
+            decompileJar(project.file("path/to/jar/to/decompile.jar"), "src/main/java")
+        }
+    }
+}
+```
+
+When using the `projectWorkspace` workspace definition, the Patchify Gradle plugin willautomatically find the best paths
+to use.
+
+If you want Patchify to handle decompilation and patching for you, use the `decompileJar` initializer. This is the step
+that is done to prepare the source-code for patching.
+
+## Command-line interface
+
+Patchify also provides a command-line interface that can be used to manage and automate patching of source-code.
 
 ```
 Usage: patchify [OPTIONS] COMMAND [ARGS]...
 
+  Patchify is a tool used to manage/automate code projects that require
+  source-code patching.
+
 Options:
   -h, --help  Show this message and exit
 
 Commands:
-  init             Initializes a git repository to be able to patch
-                   source-code
-  rebuild-patches  Rebuild patches.
-  apply-patches    Apply all patches to the project.
-  edit-patch       Edits a patch
+  init             Initialize a new patchify workspace
+  apply-patches    Apply all patches to the source code
+  rebuild-patches  Rebuilds all patches
 ```
 
-## Commands
+### Commands
 
-| Command                 | Description                                                                  |
-|:-----------------------:| ---------------------------------------------------------------------------- |
-| `init`                  | Initializes a git repository to be able to patch source-code.                |
-| `rebuild-patches`       | Rebuild patch files through the commits done to the source directory.        |
-| `apply-patches`         | Applies the patches on the `patches` directory to the `source` directory     |
-| `edit-patch`            | Allows you to edit an existing patch by rolling back to the commit.          |
-| `edit-patch --continue` | Finishes the edit of the specific patch. Automatically rebuilds the patches. |
-| `edit-patch --abort`    | Cancels the edit of the specific patch.                                      |
+|         Command         | Description                                                                  |
+|:-----------------------:|------------------------------------------------------------------------------|
+|         `init`          | Initializes a git repository to be able to patch source-code.                |
+|    `rebuild-patches`    | Rebuild patch files through the commits done to the source directory.        |
+|     `apply-patches`     | Applies the patches on the `patches` directory to the `source` directory     |

build.gradle.kts

@@ -7,7 +7,7 @@ allprojects {
     version = "2.1.0-SNAPSHOT"
 }
 
-arrayOf("core", "gradle-plugin").forEach { name ->
+arrayOf("core", "cli", "gradle-plugin").forEach { name ->
     project(name) {
         apply(plugin = "org.jetbrains.kotlin.jvm")
         apply(plugin = "java-library")

cli/build.gradle.kts

@@ -16,4 +16,16 @@ dependencies {
 
     /* Jackson - Json Parser */
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.13.3")
+}
+
+application {
+    mainClass.set("io.github.nickacpt.patchify.cli.EntrypointKt")
+}
+
+tasks {
+    shadowJar {
+        manifest {
+            attributes(mapOf("Main-Class" to application.mainClassName))
+        }
+    }
 }