1.0.4 released

This reverts commit a6c803a17d.

.travis.yml

@@ -1,5 +1,3 @@
 language: node_js
 node_js:
-  - '4'
-  - '6'
-sudo: false
+  - node

CHANGELOG.md

@@ -1,3 +1,23 @@
+1.0.4 / 2020-02-05
+------------------
+
+- Added TS definition.
+
+
+1.0.3 / 2019-11-04
+------------------
+
+- Update mapping data to version 12.1.0
+  http://www.unicode.org/Public/security/latest/confusables.txt
+- Dev deps bump.
+
+1.0.2 / 2017-03-05
+------------------
+
+- Update mapping data to version 9.0.0
+  http://www.unicode.org/Public/security/latest/confusables.txt
+
+
 1.0.1 / 2016-12-09
 ------------------
 

README.md

@@ -4,8 +4,14 @@
 [![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), v8.0.0.
+Data source - [Recommended confusable mapping for IDN](http://www.unicode.org/Public/security/latest/confusables.txt), v12.1.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,18 @@ npm install unhomoglyph --save
 const unhomoglyph = require('unhomoglyph');
 
 console.log(unhomoglyph('AΑАᎪᗅᴀꓮ')); // => AAAAAAA
+console.log(unhomoglyph('m'));        // => rn (r + n)
+
+//
+// Compare nicknames
+//
+
+const username1 = 'm';
+const username2 = 'rn';
+
+if (unhomoglyph(username1) === unhomoglyph(username2)) {
+  console.log(`"${username1}" and "${username2} look similar`);
+}
 ```
 
 

index.d.ts

@@ -0,0 +1,4 @@
+declare module 'unhomoglyph' {
+    const unhomoglyph: (s: string) => string;
+    export default unhomoglyph;
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "unhomoglyph",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "Replace all homoglyphs with base characters.",
   "keywords": [
     "homoglyph",
@@ -18,7 +18,7 @@
     "update": "node update.js && npm test"
   },
   "devDependencies": {
-    "eslint": "^3.11.1",
-    "mocha": "^3.2.0"
+    "eslint": "^6.6.0",
+    "mocha": "^6.2.2"
   }
 }