From e6022bb73e810c9262eea11a580da680bcf1c35c Mon Sep 17 00:00:00 2001 From: Matteo Manzinello Date: Mon, 13 May 2019 16:38:31 +0200 Subject: [PATCH] updated README --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 91f7bf4..c4faa3a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![mailgo screencast](/assets/video/mailgo-screencast.gif) (see it in action! ) -See the docs on npm for a more stable version of mailgo, the README of GitHub is referencing to the latest WIP **mailgo**: 0.3.0. +docs: npm ## what? @@ -43,15 +43,11 @@ you can also import mailgo in `` 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** +(to exclude a single mailto link add to the `` element the class `no-mailgo`) -to exclude a single mailto link add to the `` element the class `no-mailgo` like in this example - -``` -matteo@manzinello.dev -``` +**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 `` 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): `write me!`