odit
/
mailymaily
4
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

updated README

This commit is contained in:
Matteo Manzinello 2019-05-13 16:38:31 +02:00
parent 4a402b1871
commit e6022bb73e
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -3,7 +3,7 @@
![mailgo screencast](/assets/video/mailgo-screencast.gif)
(see it in action! <https://mailgo.js.org>)
See the <a href="https://www.npmjs.com/package/mailgo">docs</a> on npm for a more stable version of mailgo, the README of GitHub is referencing to the latest WIP **mailgo**: 0.3.0.
docs: <a href="https://www.npmjs.com/package/mailgo">npm</a>
## what?
@ -43,15 +43,11 @@ you can also import mailgo in `<head>` using `defer`
### default
**by default all the `mailto:` links will be enabled with mailgo automatically** (and with the default usage in the modal will appear also cc, bcc, subject and body parameter, if provided)
**by default all the `mailto:` links will be enabled with mailgo automatically** and will appear also cc, bcc, subject and body parameter, if provided
**Do you want to prevent the spam? Use a _no-spam usage_ instead the default usage**
<small>(to exclude a single mailto link add to the `<a>` element the class `no-mailgo`)</small>
to exclude a single mailto link add to the `<a>` element the class `no-mailgo` like in this example
```
<a class="no-mailgo" href="mailto:matteo@manzinello.dev">matteo@manzinello.dev</a>
```
**do you want to prevent the spam? Use a _no-spam usage_ instead the default usage**
### no-spam usage #1 (recommended)
@ -83,11 +79,13 @@ to exclude a single mailto link add to the `<a>` element the class `no-mailgo` l
- `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
---
## examples
This is a complete **mailgo** example with the no-spam usage #1:
this is a complete **mailgo** example with the no-spam usage #1 (and cc, bcc, subject and body):
`<a href="#mailgo" data-address="matteo" data-domain="manzinello.dev" data-cc-address="matteomanzinello" data-cc-domain="gmail.com" data-bcc-address="hello" data-bcc-domain="matteomanzinello.com" data-subject="A strange email" data-body="This email is for me with me also in cc and in bcc">write me!</a>`