diff --git a/README.md b/README.md index b1ac95f..ca43171 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,26 @@ -

- - mailymaily - -

- -

A simple way to enhance your mailto links with a convenient user interface.

- -

- Latest release - Total downloads - License - Share on Twitter -

- ## Introduction 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 or their default local email app. 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. +## Build + +``` +yarn && yarn build +``` + ## Quick Setup ### STEP 1 -Add mailymaily via CDN to the bottom of your page, just before the closing `` tag. - -IMPORTANT: Be sure to replace `[version]` with the latest version number. +Add mailymaily to your body. ```html ... ... - + ``` @@ -43,17 +32,4 @@ Attach your mailto link to mailymaily by adding the class `mailymaily` to the `< Contact Tony ``` -That's it! Your mailto link is now using mailymaily. Refresh your page and try it out. - - -## Documentation - -For full documentation, visit [mailymaily.com](https://mailymaily.com). - -## Contributing - -If you're interested in contributing to mailymaily, please follow the directions in the [contributing docs](https://github.com/mariordev/mailymaily/blob/master/.github/CONTRIBUTING.md) **before working on a pull request**. - -## License - -[MIT](https://github.com/mariordev/mailymaily/blob/master/LICENSE) +That's it! Your mailto link is now using mailymaily. Refresh your page and try it out. \ No newline at end of file