From a606878cbfafe058dd2e786c28162638f538e138 Mon Sep 17 00:00:00 2001
From: Niggl <info@nicolai-ort.com>
Date: Sat, 29 Aug 2020 18:06:14 +0200
Subject: [PATCH] Added README in addition to the example

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ff11f0c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# ODIT.Services - MailyMaily
+A better mailto based on mailtoui
+
+## 🛠 Building
+```
+yarn && yarn build
+```
+
+## Use
+
+[Example](index.html)
+
+Basic: Link the dist file "mailymaily-min.js" at the bottom of your footer.
+```html
+<script src="your/path/to/mailymaily-min.js"></script>
+```
+
+Alternatively: Add defer or async=false when linking in the header
+```html
+    <script src="your/path/to/mailymaily-min.js" defer></script>
+    <!-- or -->
+    <script src="your/path/to/mailymaily-min.js" async=false></script>
+```
+
+### VueJS & NuxtJs
+
+Place the dist file "mailymaily-min.js" in the static folder.
+Link the dist file at the bottom of your layout, for example:
+```html
+<template>
+  <div>
+    <Header />
+    <Nuxt />
+    <Footer />
+    <script src="/libs/mailymaily-min.js"></script>
+  </div>
+</template>
+```
\ No newline at end of file