From feaf36793f64ee91dea4794369b9ddb15fdb4c3c Mon Sep 17 00:00:00 2001
From: FalsePattern <30945458+FalsePattern@users.noreply.github.com>
Date: Thu, 30 Mar 2023 17:18:19 +0200
Subject: [PATCH] update readme

---
 readme.md | 45 +++++++++++++++++++++++++++++++++++++--------
 1 file changed, 37 insertions(+), 8 deletions(-)

diff --git a/readme.md b/readme.md
index a1ab780..f4c29e1 100644
--- a/readme.md
+++ b/readme.md
@@ -1,13 +1,13 @@
-Minecraft mod: ChunkAPI
-- Author: FalsePattern 
-- Type: library, coremod
-- Status: in progress
+# ChunkAPI
+
+## Author: FalsePattern
+## License: No derivatives visible-source with API exception. See the LICENSE file for more details.
 
 
 Summary
 -------
 
-A mod for adding custom data to chunks.
+A mod for adding custom data to chunks without the hassle of writing custom packets, event handling, loading hooks, and more.
 
 Goals
 -----
@@ -23,6 +23,9 @@ Non-Goals
 It is not a goal to provide any kind of callback/hook system for anything except saving/loading and netcode, any kind
 of extra behavior should be implemented in the mod using ChunkAPI.
 
+Storage is not provided by the API, the user is expected to implement their own storage system. A good example
+is using a mixin to add a field to the chunk class, and using that field to store the data.
+
 Motivation
 ----------
 
@@ -33,7 +36,30 @@ to modify any of the vanilla classes yourself.
 Description
 -----------
 
-//TODO no solid plan yet, gotta think about it some more
+The API exposes a way to add custom data to chunks, and a way to register custom serializers for the data.
+
+### ChunkDataManager
+The `ChunkDataManager` itself is the primary class used for managing registrations, but does not implement functionality
+by itself. For that, you need to use the `PacketDataManager`, `ChunkNBTDataManager`, and `SectionNBTDataManager`
+interfaces included inside the ChunkDataManager class.
+
+### ChunkDataManager.PacketData
+This interface is used for synchronizing data from the server to the client. If your data is only required on the server,
+you can freely skip implementing this interface.
+
+### ChunkDataManager.ChunkNBTData
+This interface is used for saving/loading data from the chunk NBT. This is required if you want to keep persistent data
+across world reloads. Note, if you store data *per block* in the chunk, you should use `SectionNBTData` instead, as it
+is designed with the internal chunk format in mind.
+
+### ChunkDataManager.SectionNBTData
+This interface is mostly identical to `ChunkNBTData`, but is designed for storing data per block in the chunk.
+Instead of being called once per chunk, it is called once per chunk section (16x16x16 blocks, `ExtendedBlockStage` class).
+
+### ChunkDataRegistry
+This is where you actually register your manager. You need to do all registrations inside the `init` phase.
+You can also disable specific manager IDs by calling `disableDataManager`, but this is not recommended,
+and should only be used if you know what you are doing.
 
 Alternatives
 ------------
@@ -53,8 +79,11 @@ This might slow down chunk loading/saving, and the networking, if the implementa
 Ideally, mods should declare their custom data as new fields in the chunk class using mixins instead of the
 ModdedChunk storage, but this is not a requirement.
 
+Ideally, this project must not have any derivatives or forks, as that will counter the primary purpose of this project,
+which is a single, unified codebase for chunk data exchange. For that goal, the project is explicitly licensed such as
+no derivatives are permitted.
+
 Dependencies
 ------------
 
-This mod directly depends on FalsePatternLib, and some sort of Mixin injector that provides SpongePowered Mixin >= 0.8.5.
-The latter requirement may change in the future.
\ No newline at end of file
+This mod directly depends on FalsePatternLib, and some sort of Mixin injector that provides SpongePowered Mixin >= 0.8.5.
\ No newline at end of file