Skip to content

Commit

Permalink
docs: Improve README
Browse files Browse the repository at this point in the history
* Update to README.md

Few changes of corrections and fixes here and there!

* Updated

Changes requested accordingly, my apologies.

* Update README.md

Amended
  • Loading branch information
karna12 authored and tmcw committed Feb 15, 2018
1 parent 99f4236 commit 5236ddf
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -47,7 +47,7 @@ $ npm install -g documentation

This installs a command called `documentation` in your path, that you can
point at [JSDoc](http://usejsdoc.org/)-annotated source code to generate
human-readable documentation. First run `documentation` with the `--help`
human-readable documentation. First, run `documentation` with the `--help`
option for help:

```sh
Expand All @@ -62,10 +62,10 @@ bin/documentation.js build src/** -f html -o docs
# document index.js, ignoring any files it requires or imports
bin/documentation.js build index.js -f md --shallow

# build and serve html docs for app.js
# build and serve HTML docs for app.js
bin/documentation.js serve app.js

# build, serve, and live-update html docs for app.js
# build, serve, and live-update HTML docs for app.js
bin/documentation.js serve --watch app.js

# validate JSDoc syntax in util.js
Expand Down

0 comments on commit 5236ddf

Please sign in to comment.