Added examples

lukem512 · Apr 3, 2016 · e5e2db8 · e5e2db8
1 parent 1797c57
commit e5e2db8
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/examples/score.js b/examples/score.js
@@ -0,0 +1,14 @@
+// Luke Mitchell, 2016
+// https://github.com/lukem512/pronounceable
+
+var pronounceable = require('pronounceable');
+
+// Scoring a word using the standard dataset.
+// The output is a normalised score. The higher the number
+// the more pronounceable the word.
+
+var morePronouncable = 'peonies';
+console.log(morePronouncable, pronounceable.score(morePronouncable));
+
+var lessPronouncable = 'sshh';
+console.log(lessPronouncable, pronounceable.score(lessPronouncable));
diff --git a/examples/test.js b/examples/test.js
@@ -0,0 +1,14 @@
+// Luke Mitchell, 2016
+// https://github.com/lukem512/pronounceable
+
+var pronounceable = require('pronounceable');
+
+// Testing a word using the standard dataset.
+// The `test` method returns true is a word is pronouncable
+// and false otherwise.
+
+var yes = 'samosa';
+console.log(yes, pronounceable.test(yes));
+
+var no = 'xghsii';
+console.log(no, pronounceable.test(no));