aggiustato il README
This commit is contained in:
parent
e7845f8c46
commit
84f64ce4f5
28
README.md
28
README.md
@ -11,34 +11,42 @@ mailgo will substitute all the `mailto:` links with the **mailgo modal**
|
|||||||
|
|
||||||
## installation
|
## installation
|
||||||
|
|
||||||
|
add at the very and of the `<body>` or in the `<head>` of your HTML
|
||||||
|
|
||||||
```
|
```
|
||||||
<script src="https://cdn.jsdelivr.net/npm/mailgo/dist/mailgo.min.js"></script>
|
<script src="https://cdn.jsdelivr.net/npm/mailgo/dist/mailgo.min.js"></script>
|
||||||
```
|
```
|
||||||
|
|
||||||
or
|
or, specifying `[VERSION]`
|
||||||
|
|
||||||
```
|
|
||||||
<script src="https://cdn.jsdelivr.net/npm/mailgo@latest/dist/mailgo.min.js"></script>
|
|
||||||
```
|
```
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
```
|
|
||||||
<script src="https://cdn.jsdelivr.net/npm/mailgo@[VERSION]/dist/mailgo.min.js"></script>
|
<script src="https://cdn.jsdelivr.net/npm/mailgo@[VERSION]/dist/mailgo.min.js"></script>
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
specifying `[VERSION]`
|
## usage
|
||||||
|
|
||||||
|
now all your `mailto` links will be mailgone!
|
||||||
|
|
||||||
|
you can also add mailgo to links like in this <u>no-spam</u> way:
|
||||||
|
|
||||||
|
`<a class="mailgo" data-address="matteo" data-domain="manzinello.dev">write me!</a>`
|
||||||
|
|
||||||
|
just adding **mailgo** as class and your email address splitted in **data-address** and **data-domain**
|
||||||
|
|
||||||
### exclude a mailto
|
### exclude a mailto
|
||||||
|
|
||||||
to exclude a mailto link add to the `<a>` element the class `no-mailgo` like in this example:
|
to exclude a 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>
|
<a class="no-mailgo" href="mailto:matteo@manzinello.dev">matteo@manzinello.dev</a>
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## docs
|
---
|
||||||
|
|
||||||
<https://mailgo.js.org>
|
|
||||||
|
|
||||||
[](https://nodei.co/npm/mailgo/)
|
[](https://nodei.co/npm/mailgo/)
|
||||||
|
|
||||||
|
<https://mailgo.js.org>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user