From 5f5e44d341734ac7d521d08471d5f2aa8a017577 Mon Sep 17 00:00:00 2001
From: Jason <11360596+jpenilla@users.noreply.github.com>
Date: Fri, 24 Sep 2021 01:34:33 -0500
Subject: [PATCH] Small readme updates (#80)

---
 readme.md | 25 +++++++++++--------------
 1 file changed, 11 insertions(+), 14 deletions(-)

diff --git a/readme.md b/readme.md
index c70474e..a357a42 100644
--- a/readme.md
+++ b/readme.md
@@ -1,25 +1,22 @@
 ## paperweight
 
-How to use this for testing:
+`paperweight` consists of three Gradle plugins:
+- `paperweight-core`: Used to build Paper
+- `paperweight-patcher`: Used to create forks of Paper or other `paperweight-patcher`-based forks
+- `paperweight-userdev`: Used to develop internals plugins using Mojang mappings
 
-Install this plugin to Maven Local:
+### How to use this for testing:
 
+- Install `paperweight` to Maven Local:
 ```bash
 ./gradlew publishToMavenLocal
 ```
+- Add `mavenLocal()` for plugin resolution in your test project
+  (see the [Gradle docs](https://docs.gradle.org/current/userguide/plugins.html#sec:custom_plugin_repositories) for more details)
+- Adjust the `paperweight` version in your test project
+  - Local versions of `paperweight` will use have the `-SNAPSHOT` suffix in the version from `gradle.properties` replaced by `-LOCAL-SNAPSHOT`
 
-Clone a new Paper repo and checkout the `feature/mojmap` branch.
-
-* Add `mavenLocal()` to the list of repos in `settings.gradle.kts`.
-* Change `paperweight` version to `1.0.0-LOCAL-SNAPSHOT` in the `plugins {}` block in `build.gradle.kts`.
-
-Run the task (on the Paper repo) to set up the development environment:
-
-```bash
-./gradlew patchPaper
-```
-
-> All task outputs `paperweight` creates goes into `<project-root>/.gradle/caches`.
+> Most output `paperweight` creates goes into `<project-root>/.gradle/caches/paperweight`
 
 ### Debugging