From 59c5f0e1516477660caf651ae4b8f076b0569141 Mon Sep 17 00:00:00 2001 From: Vitaly Puzrin Date: Sun, 5 Mar 2017 06:06:21 +0300 Subject: [PATCH] Add more explanations to readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 5ff8c9e..0422182 100644 --- a/README.md +++ b/README.md @@ -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) ```