Browse Source

Updated readme with the new installation instructions✏

master
Nicolai Ort 1 year ago
parent
commit
9a9b242b91
  1. 24
      README.md

24
README.md

@ -1,8 +1,9 @@
# ODIT.Services - MailyMaily
A better mailto based on mailtoui
A better mailto based on [mailtoui](https://github.com/mariordev/mailtoui).
## 🛠 Building
```
```bash
yarn && yarn build
```
@ -10,16 +11,29 @@ yarn && yarn build
[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.
```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
```html
<script src="your/path/to/mailymaily.min.js" defer></script>
<script src="node_modules/@odit/mailymaily/dist/mailymaily.min.js" defer></script>
<!-- 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

Loading…
Cancel
Save