Permalink
Browse files

Update readme a wee bit.

  • Loading branch information...
1 parent 503531d commit a0f4496e95c2a4bcfd224911e17a3971ec7e2759 @msiebuhr msiebuhr committed Aug 16, 2012
Showing with 12 additions and 3 deletions.
  1. +12 −3 README.md
View
@@ -3,7 +3,16 @@ OneDox
Not-Invented-Here version of docco / dox (before it stopped outputting HTML).
-AUTHOR
-======
- * Morten Siebuhr <msi@one.com>
+Generates a bunch of HTML where block comments is shown side-by-side with the
+source code.
+
+Usage:
+
+ onedox --out doc/ file1.js lib/file2.js lib/file3.js ...
+
+Install
+-------
+
+ npm install onedox
+(Or clone this repo and run `npm install`.)

0 comments on commit a0f4496

Please sign in to comment.