mailymaily/README.md

35 lines
876 B
Markdown
Raw Normal View History

2020-08-29 11:55:43 +00:00
## Introduction
2020-08-29 11:59:02 +00:00
mailymaily is a JavaScript library that enhances your mailto links with a convenient user interface. It gives your users the flexibility to compose a new message using a browser-based email client <strong><i>or</i></strong> their default local email app.
2020-08-29 11:55:43 +00:00
2020-08-29 11:59:02 +00:00
mailymaily is ideal for static sites or any other site where you don't want to spend time setting up a "Contact Us" form solution.
2020-08-29 11:55:43 +00:00
2020-08-29 12:10:03 +00:00
## Build
```
yarn && yarn build
```
2020-08-29 11:55:43 +00:00
## Quick Setup
### STEP 1
2020-08-29 12:10:03 +00:00
Add mailymaily to your body.
2020-08-29 11:55:43 +00:00
```html
<body>
...
...
2020-08-29 12:10:03 +00:00
<script src="assets/mailymaily-min.js"></script>
2020-08-29 11:55:43 +00:00
</body>
2020-08-23 12:46:28 +00:00
```
2020-08-29 11:55:43 +00:00
### STEP 2
2020-08-29 11:59:02 +00:00
Attach your mailto link to mailymaily by adding the class `mailymaily` to the `<a>` tag.
2020-08-29 11:55:43 +00:00
```html
2020-08-29 11:59:02 +00:00
<a class="mailymaily" href="mailto:tony.stark@example.com">Contact Tony</a>
2020-08-23 12:46:28 +00:00
```
2020-08-29 11:55:43 +00:00
2020-08-29 12:10:03 +00:00
That's it! Your mailto link is now using mailymaily. Refresh your page and try it out.