Added README in addition to the example

This commit is contained in:
Nicolai Ort 2020-08-29 18:06:14 +02:00
parent a46636fb36
commit a606878cbf
1 changed files with 38 additions and 0 deletions

38
README.md Normal file
View File

@ -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>
```