Rename sportsgame to sports. Update readme.

stereosteve · May 31, 2013 · f2bdf14 · f2bdf14
1 parent 0c5d2fc
commit f2bdf14
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -5,6 +5,23 @@ Generate random words and phrases: names, places, numbers, etc.
 This is a rewrite of Faker.js with a saner API and simpler implementation.
 It also incorporates new word lists for nouns, verbs, etc.
 
+## Installation
+
+```
+npm install madlibs
+```
+
+## Usage
+
+```js
+var madlibs = require('madlibs')
+madlibs.noun()
+madlibs.verb()
+madlibs.fullName()
+madlibs.email()
+madlibs.address()
+```
+
 ## Test
 
 To see example output, run `npm test`:
@@ -55,6 +72,7 @@ To see example output, run `npm test`:
 ## Roadmap
 
 * Work in browser via component.js
+* Generate full example objects: user, company, etc.
 * Generate words, sentances, paragraphs (a-la faker)
 * Simple templating / interpolation, so it can actually be used for MadLibs
 

diff --git a/dict/sportsgame.js → dict/sport.js b/dict/sportsgame.js → dict/sport.js