Update README.md

alexkilgour · Nov 13, 2015 · 024dc0e · 024dc0e
1 parent 99b186a
commit 024dc0e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,14 @@ Generates a random item from an array
 chancer.fromArray([ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]); // 6
 ```
 
+### chancer.shuffleArray( arr )
+Generates an array shuffled into a random order  
+**arr:** *(array)* Array of items  
+**return:** *(integer)* Returns the array shuffled into a random order
+```js
+chancer.shuffleArray([ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]); // [7, 3, 9, 4, 1, 6, 2, 5, 8]
+```
+
 ## Browser Support
 Tested in the following browsers