https://github.com/danmurf/revealme.js
Lightweight JavaScript email address obfuscation
https://github.com/danmurf/revealme.js
Last synced: 5 months ago
JSON representation
Lightweight JavaScript email address obfuscation
- Host: GitHub
- URL: https://github.com/danmurf/revealme.js
- Owner: danmurf
- License: mit
- Created: 2016-12-17T07:49:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-27T08:36:21.000Z (over 1 year ago)
- Last Synced: 2025-11-27T10:18:50.925Z (7 months ago)
- Language: JavaScript
- Size: 269 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# revealme.js
*Lightweight JavaScript email address obfuscation*
[](https://travis-ci.org/danmurf/revealme.js)
- - -
Use revealme.js in your web page so you can include a link to your email address without having to actually write it out. If you're worried about getting spam because you'd like to put your email address on a publicly accessible page, this script is for you.
*Note: this script won't stop you getting spam, but it will make it much harder for automated scripts to harvest an email address from your pages.*
## Usage
1) Include revealme.js in your html
```html
```
2) Add email addresses to you HTML in a phonetic form, and encapsulate them in the revealme class.
```html
My email address jessie dot wongus at example hyphen domain dot com
```
3) Email addresses will be automatically converted to a link and obfuscated.
Example:
```
My email address is jessie.w...main.com (click to reveal)
```
Once the address has been clicked, the email address will be revealed with a properly formatted mailto link.
```
My email address is jessie.wongus@example-domain.com
```
## License
revealme.js is released under the MIT license.