diff --git a/README.md b/README.md index 9ec782d..9397265 100644 --- a/README.md +++ b/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 - + ``` Alternatively: Add defer or async=false when linking in the header ```html - + - + ``` ### VueJS & NuxtJs