diff --git a/README.md b/README.md index 27731c2..bdba0b8 100644 --- a/README.md +++ b/README.md @@ -4,135 +4,4 @@ ![npm](https://img.shields.io/npm/v/mailgo.svg?style=flat-square) [![mailgo.min.js size](https://img.shields.io/github/size/manzinello/mailgo/dist/mailgo.min.js.svg?label=mailgo.min.js&style=flat-square)](https://unpkg.com/mailgo@0.4.2/dist/mailgo.min.js) [![mailgo.min.js size](https://img.shields.io/github/size/manzinello/mailgo/dist/mailgo.min.css.svg?label=mailgo.min.css&style=flat-square)](https://unpkg.com/mailgo@0.4.2/dist/mailgo.min.css) -### docs: npm - -## what? - -mailgo will substitute all the `mailto:` links with the **mailgo modal** - -mailgo modal - ---- - -## installation - -add at the end of the `` - -``` - -... - - -``` - -you can also import mailgo in `` using `defer` - -``` - -... - - -``` - -(note: the GitHub `/dist` folder is totally unstable, use `unpkg` to test **mailgo**, thanks!) - ---- - -## usage - -**by default all the `mailto:` links will be enabled with mailgo automatically** and will appear also cc, bcc, subject and body parameter, if provided - -(to exclude a single mailto link add to the `` element the class `no-mailgo`) - -**do you want to prevent the spam? Use a _spam-less usage_ instead the default usage** - -### spam-less usage #1 (recommended) - -`write me!` - -- add `href="#mailgo"` to `` -- add `data-address` and `data-domain` to re-create your email address - -### spam-less usage #2 - -`write me!` - -- add `class="mailgo"` to `` -- add `data-address` and `data-domain` to re-create your email address - -### spam-less usage #3 - -`write me!` - -- add the attribute `mailgo` to `` -- add `data-address` and `data-domain` to re-create your email address - -### cc, bcc, body, subject and multiple email addresses - -**mailgo** also supports cc, bcc, subject and body in spam-less installation using the parameters: - -- `data-cc-address` and `data-cc-domain` to recreate cc: `data-cc-address@data-cc-domain` -- `data-bcc-address` and `data-bcc-domain` to recreate bcc: `data-bcc-address@data-bcc-domain` -- `data-subject` for the subject of the email -- `data-body` for the body of the email - -for the default installation you can use the classic mailto parameters and they will appear in the modal - -mailgo doesn't support multiple email addresses in to, cc and bcc at the moment, but there is an issue for this! - ---- - -## keyboard commands - -from mailgo 0.4.0, when a **mailgo** modal is showing, there are also keyboard commands that can perform different actions - -- pressing **g** perform the **open in Gmail** action -- pressing **o** perform the **open in Outlook** action -- pressing **spacebar** or **enter** perform the **open default** action -- pressing **c** perform the **copy** action - ---- - -## examples - -this is a complete **mailgo** example with the spam-less usage #1 (and cc, bcc, subject and body): - -`write me!` - -This is a more simple example (also with spam-less #1 usage): - -`write me!` - ---- - -## browsers support (WIP) - -`"browserslist": "> 0.25%, not dead"` - -see the compatibility of mailgo on browserl.ist - ---- - -## connected projects - -### mailgo Chrome extension (WIP) - - - -### mailgo React component (WIP) - - - -### mailgo WordPress plugin (WIP) - - - ---- - -## open source helpers - -[![Open Source Helpers](https://www.codetriage.com/manzinello/mailgo/badges/users.svg)](https://www.codetriage.com/manzinello/mailgo) - ---- - -[![NPM](https://nodei.co/npm/mailgo.png?stars=true)](https://www.npmjs.com/package/mailgo) +## see the docs on