Skip to content

Commit

Permalink
Merge pull request lukem512#1 from gabrielecirulli/master
Browse files Browse the repository at this point in the history
Fix typo of `pronounceable`
  • Loading branch information
lukem512 authored Jun 24, 2016
2 parents 87b0167 + ffa5992 commit d03cc65
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ Then, to test a word for pronounceability, use the `test` method.
console.log(pronounceable.test('xghsii')); // false
```

You can also use the module to score a word on its pronounceability, using the `score` method. The higher the output value the more pronouncable the word.
You can also use the module to score a word on its pronounceability, using the `score` method. The higher the output value the more pronounceable the word.

```
console.log(pronouncable.score('peonies')); // 0.10176356810708122
console.log(pronouncable.score('sshh')); // 0.0008556941146173743
console.log(pronounceable.score('peonies')); // 0.10176356810708122
console.log(pronounceable.score('sshh')); // 0.0008556941146173743
```

To generate your own dataset use the `train` method.

```
pronouncable.train('dictionary.txt', function(probabilities) {
pronounceable.train('dictionary.txt', function(probabilities) {
// The data set has been returned
console.log(probabilities);
});
Expand Down

0 comments on commit d03cc65

Please sign in to comment.