From bfe0005433f5fd84d47a310578e6d4da4cfcc43d Mon Sep 17 00:00:00 2001 From: Kyle Gunger Date: Sat, 9 Jan 2021 04:06:00 -0500 Subject: Revert README --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fd96346..873c2b5 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. -- cgit v1.2.3