odit
/
mailymaily
4
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

Updated readme with the new installation instructions✏

This commit is contained in:
Nicolai Ort 2020-08-30 15:40:00 +02:00
parent e064b94651
commit 9a9b242b91
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,8 +1,9 @@
# ODIT.Services - MailyMaily # ODIT.Services - MailyMaily
A better mailto based on mailtoui A better mailto based on [mailtoui](https://github.com/mariordev/mailtoui).
## 🛠 Building ## 🛠 Building
``` ```bash
yarn && yarn build yarn && yarn build
``` ```
@ -10,16 +11,29 @@ yarn && yarn build
[Example](index.html) [Example](index.html)
### Install
Via yarn/npm:
```bash
yarn add @odit/mailymaily
# Or
npm i @odit/mailymaily
```
Or just copy the file `dist/mailymaily.js` to your prefered folder.
### Link
Basic: Link the dist file `mailymaily.min.js` at the bottom of your footer. Basic: Link the dist file `mailymaily.min.js` at the bottom of your footer.
```html ```html
<script src="your/path/to/mailymaily.min.js"></script> <script src="node_modules/@odit/mailymaily/dist/mailymaily.min.js"></script>
``` ```
Alternatively: Add defer or async=false when linking in the header Alternatively: Add defer or async=false when linking in the header
```html ```html
<script src="your/path/to/mailymaily.min.js" defer></script> <script src="node_modules/@odit/mailymaily/dist/mailymaily.min.js" defer></script>
<!-- or --> <!-- or -->
<script src="your/path/to/mailymaily.min.js" async=false></script> <script src="node_modules/@odit/mailymaily/dist/mailymaily.min.js" async=false></script>
``` ```
### VueJS & NuxtJs ### VueJS & NuxtJs