litruv/unhomoglyph
1
0
Fork 0
mirror of https://github.com/litruv/unhomoglyph.git synced 2026-07-24 02:36:12 +10:00
Code Issues Packages Projects Releases Wiki Activity

Add more explanations to readme

Browse Source
This commit is contained in:
Vitaly Puzrin
2017-03-05 06:06:21 +03:00
parent 0bc3804849
commit 59c5f0e151
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -4,9 +4,15 @@
[![NPM version](https://img.shields.io/npm/v/unhomoglyph.svg?style=flat)](https://www.npmjs.org/package/unhomoglyph)
> Replace all homoglyphs with base characters. Useful to detect similar strings.
For example, to prohibit register similar looking nicknames at websites.
Data source - [Recommended confusable mapping for IDN](http://www.unicode.org/Public/security/latest/confusables.txt), v9.0.0.
__Note!__ Text after transform is NOT intended be read by humans. For example,
`m` will be transformed to `r` + `n`. Goal is to compare 2 strings after
transform, to check if sources looks similar or not. If sources look similar,
then transformed strings are equal.
## Install
@@ -21,6 +27,7 @@ npm install unhomoglyph --save
const unhomoglyph = require('unhomoglyph');
console.log(unhomoglyph('AΑАᎪᗅᴀꓮ')); // => AAAAAAA
console.log(unhomoglyph('m')); // => rn (r + n)
```