From 73b6f703307b4524fadead8fd0977c67b028e1f6 Mon Sep 17 00:00:00 2001
From: IRONM00N <64110067+IRONM00N@users.noreply.github.com>
Date: Mon, 8 Mar 2021 21:35:04 -0500
Subject: add readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d1c5c538
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+<h1 align = "center"> NotEnoughUpdates-REPO </h1>
+
+This repository is used in order to store the various JSON files used for the Minecraft mod [NotEnoughUpdates](https://github.com/Moulberry/NotEnoughUpdates).
+
+<h2 align = "center"> How to contribute </h2>
+
+In order to contribute to the item repo you should enable the item editor tools by editing your config, in your configNew.json (.minecraft/config/notenoughupdates/configNew.json) ensure the following values are set:
+
+```json
+"enableItemEditing": true,
+"dev": true,
+```
+
+Once you have these options enabled you can edit and add items in-game using the following keybinds:
+
+* `k` - Open the item editor.
+* `o` - While in an items recipe menu, add the recipe.
+* `y` - Opens a pane on the right side of your inventory 
+
+If you need further help on how to contribute feel free to join the [discord](https://discord.gg/moulberry) or contact `IRONM00N#0001`.
-- 
cgit