diff --git a/README.md b/README.md index 4c6c2d5..4edb52e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# gibberish +# gibb -`gibberish` is an NPM package capable to detect gibberish. It uses a 2 character [Markov chain](http://en.wikipedia.org/wiki/Markov_chain). +`gibb` is an NPM package capable to detect gibberish. It uses a 2 character [Markov chain](http://en.wikipedia.org/wiki/Markov_chain). Ported to JavaScript from Python implementation: https://github.com/rrenaud/Gibberish-Detector @@ -13,7 +13,7 @@ npm install gibberish ## How to use ```javascript -import {isGibberish} from 'gibberish'; +import {isGibberish} from 'gibb'; console.log(isGibberish('my name is rob and i like to hack')); // false console.log(isGibberish('is this thing working?')); // false @@ -28,7 +28,7 @@ console.log(isGibberish('yay!')); // false ## Advanced usage ```javascript -import {train, isGibberish} from 'gibberish'; +import {train, isGibberish} from 'gibb'; train('./my-model.json', './line-separated-dataset.txt', './good-probes.txt', './bad-probes.txt'); diff --git a/package.json b/package.json index 023fa9a..eda1610 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "gibberish", + "name": "gibb", "version": "1.0.0", "description": "Gibberish detection algorithm based on Markov chain", "main": "index.mjs",