Permalink
Browse files

readme with example

  • Loading branch information...
1 parent 9b8e73c commit 03b3073031c121cb7ba4019b8d83011f56fee1b5 @substack committed May 12, 2012
Showing with 51 additions and 0 deletions.
  1. +48 −0 README.markdown
  2. +3 −0 example/name.js
View
@@ -0,0 +1,48 @@
+identifier
+==========
+
+Generate random javascript identifiers.
+
+This is probably only useful if you're doing hackish tricks involving AST
+transforms or whatevers.
+
+example
+=======
+
+``` js
+var identifier = require('identifier');
+var name = identifier(16);
+console.log(name);
+```
+
+output:
+
+```
+KAUfaA66_BYii1Oq
+```
+
+methods
+=======
+
+``` js
+var identifier = require('identifier')
+```
+
+identifier(n)
+-------------
+
+Return a valid javascript identifier string `n` characters long.
+
+install
+=======
+
+With [npm](http://npmjs.org) do:
+
+```
+npm install identifier
+```
+
+license
+=======
+
+MIT
View
@@ -0,0 +1,3 @@
+var identifier = require('../');
+var name = identifier(16);
+console.log(name);

0 comments on commit 03b3073

Please sign in to comment.