Change the API

sindresorhus · Jul 14, 2018 · aaf72e0 · aaf72e0
1 parent bd590ca
commit aaf72e0
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 17 deletions.
diff --git a/index.js b/index.js
@@ -2,5 +2,5 @@
 const uniqueRandomArray = require('unique-random-array');
 const words = require('./words.json');
 
-module.exports = uniqueRandomArray(words);
-module.exports.words = words;
+module.exports.all = words;
+module.exports.random = uniqueRandomArray(words);
diff --git a/package.json b/package.json
@@ -26,8 +26,7 @@
 		"words",
 		"list",
 		"array",
-		"random",
-		"rand"
+		"random"
 	],
 	"dependencies": {
 		"unique-random-array": "^1.0.0"

diff --git a/readme.md b/readme.md
@@ -19,30 +19,29 @@ $ npm install superb
 ```js
 const superb = require('superb');
 
-superb();
+superb.random();
 //=> 'legendary'
 
-superb();
+superb.random();
 //=> 'awesome'
 
-superb.words;
+superb.all;
 //=> ['superb', 'legendary', …]
 ```
 
-
 ## API
 
-### superb()
+### .all
 
-Type: `string`
+Type: `Array`
 
-Random [superb like word](words.json).
+All the words in alphabetical order.
 
-### superb.words
+### .random()
 
-Type: `Array`
+Type: `Function`
 
-All the words.
+Random word.
 
 
 ## Related

diff --git a/test.js b/test.js
@@ -2,7 +2,7 @@ import test from 'ava';
 import superb from '.';
 
 test('main', t => {
-	t.true(superb().length > 0);
-	t.true(Array.isArray(superb.words));
-	t.true(superb.words[3].length > 0);
+	t.true(superb.random().length > 0);
+	t.true(Array.isArray(superb.all));
+	t.true(superb.all[3].length > 0);
 });