From 554258e59690f431a269cd603aaa6d9c7b36392f Mon Sep 17 00:00:00 2001
From: Johan de Klerk <jdeklerk00@gmail.com>
Date: Fri, 1 Oct 2021 08:18:18 +0200
Subject: [PATCH] Updated readme

---
 .idea/.gitignore  |  5 +++++
 .idea/aws.xml     | 17 +++++++++++++++++
 .idea/mage.iml    |  9 +++++++++
 .idea/modules.xml |  8 ++++++++
 .idea/vcs.xml     |  6 ++++++
 README.md         | 16 +++++++++++++++-
 6 files changed, 60 insertions(+), 1 deletion(-)
 create mode 100644 .idea/.gitignore
 create mode 100644 .idea/aws.xml
 create mode 100644 .idea/mage.iml
 create mode 100644 .idea/modules.xml
 create mode 100644 .idea/vcs.xml

diff --git a/.idea/.gitignore b/.idea/.gitignore
new file mode 100644
index 0000000..8675629
--- /dev/null
+++ b/.idea/.gitignore
@@ -0,0 +1,5 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# CodeStream ignored files
+/codestream.xml
diff --git a/.idea/aws.xml b/.idea/aws.xml
new file mode 100644
index 0000000..10cf24e
--- /dev/null
+++ b/.idea/aws.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="accountSettings">
+    <option name="activeProfile" value="profile:default" />
+    <option name="activeRegion" value="af-south-1" />
+    <option name="recentlyUsedProfiles">
+      <list>
+        <option value="profile:default" />
+      </list>
+    </option>
+    <option name="recentlyUsedRegions">
+      <list>
+        <option value="af-south-1" />
+      </list>
+    </option>
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/mage.iml b/.idea/mage.iml
new file mode 100644
index 0000000..5e764c4
--- /dev/null
+++ b/.idea/mage.iml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="Go" enabled="true" />
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 0000000..bb56b41
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/mage.iml" filepath="$PROJECT_DIR$/.idea/mage.iml" />
+    </modules>
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..94a25f7
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/README.md b/README.md
index dc29835..4281522 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # Mage
 
-Shared code to build the backend
+Shared code to build the uAfrica and Ship-logic backend
+
+### How to include in your project
+Run this command to add the _magefile folder as a submodule
+```shell
+git submodule add https://gitlab.com/uafrica/mage.git _magefile
+```
+Remember to commit the `.gitmodules` and `_magefile` files to your repo
+
+
+### Update submodule in your repo
+Run this in your repo to update the submodule
+```shell
+git submodule update --recursive --remote
+```
\ No newline at end of file
-- 
GitLab