Skip to content
This repository has been archived by the owner on Apr 14, 2020. It is now read-only.

Commit

Permalink
Update readme a wee bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
msiebuhr committed Aug 16, 2012
1 parent 503531d commit a0f4496
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Expand Up @@ -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.