From 0c705fa3bae590955547690314bf121a26025e3e Mon Sep 17 00:00:00 2001 From: shedaniel Date: Thu, 18 Feb 2021 14:55:55 +0800 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9d536685..0ce54cff 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,26 @@ -# Architectury +# Architectury API Talk to us on [Discord](https://discord.gg/C2RdJDpRBP)! An intermediary api aimed to ease developing multiplatform mods. -### What is Architectury -Architectury is an api to abstract calls to fabric api and forge api as both loader has different implementations of what can be perceived as the same thing. +### What is Architectury API +Architectury API is an api to abstract calls to fabric api and forge api as both loader has different implementations of what can be perceived as the same thing. -Architectury updates regularly, with new hooks and features. Currently contains over **60** events hooks, networking abstraction, loader calls abstraction, game registry abstraction and an easy to use @ExpectPlatform annotation (Only works on static methods). +Architectury API updates regularly, with new hooks and features. Currently contains over **90** events hooks, networking abstraction, loader calls abstraction, game registry abstraction and an easy to use @ExpectPlatform annotation (Only works on static methods). + +### Do I really need this API? +Architectury API is only one part of the architectury ecosystem, **Architectury Plugin** is the gradle plugin enabling all this multiplatform actions. + +Architectury API is optional for projects built on architectury, you may create your architectury project with just Architectury Plugin. ### Advantages of Architectury - Open sourced - Less boilerplate for your multiplatform mod ### Getting started with making multiplatform mods -Gradle Plugin: https://github.com/architectury/architect-plugin +Gradle Plugin: https://github.com/architectury/architectury-plugin -Example Mod: https://github.com/architectury/architect-example-mod +Example Mod: https://github.com/architectury/architectury-example-mod ### Credits This library bundles typetools, which you can find its license [here](https://github.com/jhalterman/typetools/blob/master/LICENSE.txt "")