summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Gunger <corechg@gmail.com>2020-10-19 01:34:01 -0400
committerGitHub <noreply@github.com>2020-10-19 01:34:01 -0400
commit38dd350dbb70b9ad44aa2c6207489aefdaf00ba8 (patch)
tree0ea8b47550204a1ce897edb168edef5a9f42e930
parent4f764fa63250b5dbad64e2d9a2d5790907664e0b (diff)
Update README.md
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index fd96346..3c7cad1 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
-# Fabric Example Mod
+# TransitAPI
+Transit is an attempt to provide simple uniform helpers for converting and transfering abstract types in Minecraft.
-## Setup
+Transit makes no assumptions about what you transfer or how you transfer it, It only provides basic types for those that need it, and a network based API for compatibility.
-For setup instructions please see the [fabric wiki page](https://fabricmc.net/wiki/tutorial:setup) that relates to the IDE that you are using.
+## A note on convention
+When working with blocks, the convention is such:
+1. The BlockEntity will impliment the INode/IAcceptorNode/IProviderNode interfaces.
+2. The Placed block will ask the blocks around it to become a provider and or an acceptor, not the other way around.
-## License
-This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
+## License
+This mod is available under the MIT licence going forward.