From d9e06980d33ec02c2321269f47ab9ec32b36551f Mon Sep 17 00:00:00 2001
From: unknown <24964441+wsor4035@users.noreply.github.com>
Date: Sat, 29 Jan 2022 22:07:53 -0500
Subject: [PATCH] add README file and documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..faa3446
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Basic Materials mod
+
+mod that adds basic material nodes and items
+
+## Install
+
+### Option 1: use content tab in minetest
+
+* click the content tab
+* search for basic materials
+* click install on basic materials
+
+### Option 2: download from [ContentDB](https://content.minetest.net/packages/VanessaE/basic_materials/)
+
+* click the above link or search for basic materials on ContentDB
+* select the download button on the basic materials page
+* extract the zip downloaded from the previous step
+* place in your mods folder
+
+### Option 3: use git
+
+* `git clone https://github.com/mt-mods/basic_materials.git`
+* `cd basic_materials`
+* `git submodule init`
+* `git submodule update`
+
+to update please use the following commands starting inside the mod directory
+
+* `git submodule sync`
+* `git submodule update`
\ No newline at end of file