From 1c8ed4be778ffdab159c9f28adfe8bacd91b2fa0 Mon Sep 17 00:00:00 2001
From: Quincy Jo <me@quincyjo.com>
Date: Sat, 1 Feb 2025 17:37:12 -0500
Subject: [PATCH] Initial pass of updating README.

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 60 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index fd93200..3675cc7 100644
--- a/README.md
+++ b/README.md
@@ -14,12 +14,68 @@ The current state of this project is as a personal project which I used locally,
 and providing a more user friendly release. At present, this will take some effort to get familiar with and use. I plan
 and hopefully making some nice quality of life improvements and expanding this readme in the future.
 
-## Running (after local compilation)
+## Modules
+
+This project contains several modules that published and available for use within your own project.
+
+### Core
+
+Core module contains the core models and utilities of the project. This includes base models for Stardrop entities and
+serialization tools.
+
+```scala
+libraryDependencies += "com.quincyjo" %% "stardrop-core" % version
+```
+
+### Alternative Textures
+
+This module contains the models and serialization tools for the Alternative Textures (AT) mod type.
+``
+
+```scala
+libraryDependencies += "com.quincyjo" %% "stardrop-alternative-textures" % version
+```
+
+### Custom Furniture
+
+This module contains the models and serialization tools for the Custom Furniture (CF) mod type.
+
+```scala
+libraryDependencies += "com.quincyjo" %% "stardrop-custom-furniture" % version
+```
+
+### Converters
+
+Finally, the `stardrop-converters` module contains tools for converting between different mod types.
+
+```scala
+libraryDependencies += "com.quincyjo" %% "stardrop-converters" % version
+```
+
+### Cli
+
+The Cli module contains the command line interface for Stardrop and is not available as a dependency. Check
+the [releases](https://github.com/quincyjo/stardrop/releases)
+page for the latest version or [built it from source](#building-cli-from-source) yourself.
+
+## [Building CLI From Source]
+
+The SBT project comes with the [sbt-assembly](https://github.com/sbt/sbt-assembly) plugin which allows for the building
+of a fat JAR file.
+
+This can be built by running the following SBT command from within the project directory. The resulting JAR file will be
+located at `./modules/cli/target/scala-2.13/stardrop.jar` assuming the CWD is the project root directory.
+
+```
+sbt cli/assembly
+```
+
+## Running the CLI JAR
 
 See the available commands and their options.
 
 ```
-java -jar ./stardrop-assembly-pre-release.jar --help
+java -jar ./stardrop.jar --help
 ```
 
 ### Common flow for converting a CF mod into an AT mod
@@ -30,7 +86,7 @@ By default, this will output the exploded mod into an `[root director name] expl
 root.
 
 ```
-java -jar ./stardrop-assembly-pre-release.jar explode \
+java -jar ./stardrop.jar explode \
 "path/to/mod/root" \
 --expand-furniture-front --copy-fourth-rotation
 ```
@@ -38,6 +94,6 @@ java -jar ./stardrop-assembly-pre-release.jar explode \
 2. Convert the exploded MOD to AT (after spot checking sprites, such as the different layers)
 
 ```
-java -jar ./stardrop-assembly-pre-release.jar convert --to AT \
+java -jar ./stardrop.jar convert --to AT \
 "path/to/mod/root/[root name] exploded" --read-furniture-front
 ```