From 4b30d61d0257e3e223e719660e53e8fb8907675f Mon Sep 17 00:00:00 2001 From: Matteo Manzinello Date: Sun, 12 May 2019 13:27:09 +0200 Subject: [PATCH] updated README --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9df6e8a..bcbeab5 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ ![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**. +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. ## what? mailgo will substitute all the `mailto:` links with the **mailgo modal** -[![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.2.9/dist/mailgo.min.js) +[![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.3.0/dist/mailgo.min.js) mailgo modal @@ -22,7 +22,7 @@ add at the end of the `` ``` ... - + ``` @@ -31,7 +31,7 @@ you can also import mailgo in `` using `defer` ``` ... - + ``` @@ -63,6 +63,13 @@ Do you want to prevent the spam? Use a _no-spam usage_ instead the default usage - add `class="mailgo"` to `` - add `data-address` and `data-domain` to re-create your email address +### no-spam usage #3 + +`write me!` + +- add the attribute `mailgo` to `` +- add `data-address` and `data-domain` to re-create your email address + #### exclude a mailto to exclude a mailto link add to the `` element the class `no-mailgo` like in this example: @@ -71,8 +78,10 @@ to exclude a mailto link add to the `` element the class `no-mailgo` like in matteo@manzinello.dev ``` +this solution can be applied only to the default installation (`` element with href starting with `mailto:`, the classic mailto link) + --- -[![NPM](https://nodei.co/npm/mailgo.png)](https://nodei.co/npm/mailgo/) +[![NPM](https://nodei.co/npm/mailgo.png?stars=true)](https://www.npmjs.com/package/mailgo)