Skip to content

Commit f217b15

Browse files
committed
Updated help and README.
1 parent 29a6798 commit f217b15

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ $ npm install doxdox -g
1515
##Usage
1616

1717
```bash
18-
Usage: doxdox <file> [options]
18+
Usage: doxdox <path> [options]
1919

2020
Options:
2121

2222
-h, --help Display this help message.
2323
-v, --version Display the current installed version.
2424
-t, --title Sets title.
2525
-d, --description Sets description.
26-
-p, --package Sets location of package.json file.
2726
-l, --layout Template to render the documentation with.
28-
-o, --output File to save documentation to. Default to stdout.
27+
-p, --package Sets location of package.json file.
28+
-o, --output File to save documentation to. Defaults to stdout.
2929

3030
Available Layouts:
3131

bin/doxdox

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ while (args.length) {
6060

6161
default:
6262
process.stdout.write('\n');
63-
process.stdout.write(chalk.blue(' Usage:') + ' doxdox <file> [options]' + '\n\n');
63+
process.stdout.write(chalk.blue(' Usage:') + ' doxdox <path> [options]' + '\n\n');
6464
process.stdout.write(' Options:' + '\n\n');
6565
process.stdout.write(chalk.yellow(' -h, --help') + '\t\tDisplay this help message.' + '\n');
6666
process.stdout.write(chalk.yellow(' -v, --version') + '\t\tDisplay the current installed version.' + '\n');
6767
process.stdout.write(chalk.yellow(' -t, --title') + '\t\tSets title.' + '\n');
6868
process.stdout.write(chalk.yellow(' -d, --description') + '\tSets description.' + '\n');
69-
process.stdout.write(chalk.yellow(' -p, --package') + '\tSets location of package.json file.' + '\n');
7069
process.stdout.write(chalk.yellow(' -l, --layout') + '\t\tTemplate to render the documentation with.' + '\n');
71-
process.stdout.write(chalk.yellow(' -o, --output') + '\t\tFile to save documentation to. Default to stdout.' + '\n');
70+
process.stdout.write(chalk.yellow(' -p, --package') + '\tSets location of package.json file.' + '\n');
71+
process.stdout.write(chalk.yellow(' -o, --output') + '\t\tFile to save documentation to. Defaults to stdout.' + '\n');
7272
process.stdout.write('\n');
7373
process.stdout.write(' Available Layouts:' + '\n\n');
7474
process.stdout.write(' - Bootstrap (default)\t (http://getbootstrap.com/)' + '\n');

0 commit comments

Comments
 (0)