Permalink
Browse files

Updated readme

  • Loading branch information...
jntn committed Jul 2, 2011
1 parent 9f905ec commit 4210f5400da9f8c751ea4b970bda4d661e07d29d
Showing with 17 additions and 0 deletions.
  1. +17 −0 README
View
17 README
@@ -0,0 +1,17 @@
+wordcube
+
+A library to create cubes of letters with hidden words. The words can be found by tracing in any direction horizontilly or vertically.
+
+ a **P** e p n
+ h **U** **Z** **Z** q
+ k j **E** **L** l
+ s e m e y
+ d i x g a
+
+To create a 5x5 word cube with random words from a word list:
+ wordcube = require('wordcube')
+ wordcube.createWordcube(5, 5, wordList, function(cube){
+ // cube is the word cube!
+ })
+
+The word list is a sorted array of uppercase words.

0 comments on commit 4210f54

Please sign in to comment.