Skip to content

Commit

Permalink
Rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
Kirill89 committed Apr 6, 2022
1 parent fc3cbc8 commit d323e5b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand All @@ -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');

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "gibberish",
"name": "gibb",
"version": "1.0.0",
"description": "Gibberish detection algorithm based on Markov chain",
"main": "index.mjs",
Expand Down

0 comments on commit d323e5b

Please sign in to comment.