Skip to content

Commit 5236ddf

Browse files
karna12tmcw
authored andcommitted
docs: Improve README
* Update to README.md Few changes of corrections and fixes here and there! * Updated Changes requested accordingly, my apologies. * Update README.md Amended
1 parent 99f4236 commit 5236ddf

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ $ npm install -g documentation
4747

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

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

65-
# build and serve html docs for app.js
65+
# build and serve HTML docs for app.js
6666
bin/documentation.js serve app.js
6767

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

7171
# validate JSDoc syntax in util.js

0 commit comments

Comments
 (0)