From 5ceae97611bb4295a1f373a2875237f8263fd24d Mon Sep 17 00:00:00 2001
From: Dangrainage <99558179+Dangrainage@users.noreply.github.com>
Date: Wed, 31 Jul 2024 22:39:51 +0200
Subject: [PATCH] Added quick start, credited author, linked to docs

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index f0ad833..d5e2157 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,15 @@
 # kubejs6-more-recipe-types
 Fork of https://github.com/gcatkjspkgs/kubejs-more-recipe-types by gcatkjspkg - all credits go to them!
 
+# QUICK START
+All new types are functions inside of the `global` object. They should be called inside of the `recipes` event like so: `global.mrt.<mod>.<type>(event, {args}, <id>)`.
+
+- the recipe id and almost all number and boolean parameters are optional
+- to use nbt in items use Item.of(`<Item>`, `<Nbt>`)
+- to use chance in items use Item.of(`<Item>`).withChance(`<Chance>`)
+For more info look at the section below.
+
+
 The docs for all mods supported by this script are here, on the original github - [docs](https://github.com/gcatkjspkgs/kubejs-more-recipe-types/tree/ad42069a450cd74d42159950bd5e290eb576959f/docs)
+
+