Skip to content

Commit b60a259

Browse files
authored
docs: fix the example on the homepage (#35)
1 parent 718bdb8 commit b60a259

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ <h1 class="pink-highlight">Yargs be a node.js library fer hearties tryin' ter pa
6565
.usage('$0 &lt;cmd&gt; [args]')
6666
.command('hello [name]', 'welcome ter yargs!', {
6767
name: {
68-
default: 'default name'
68+
default: 'default name',
69+
describe: 'the name to say hello to'
6970
}
7071
}, function (argv) {
7172
console.log('hello', argv.name, 'welcome to yargs!')
@@ -80,22 +81,21 @@ <h1 class="pink-highlight">Yargs be a node.js library fer hearties tryin' ter pa
8081

8182
<pre>
8283
<code class="hljs language-bash">
83-
$ node example.js --help
84+
$ example.js --help
8485
</code>
8586
</pre>
8687

8788
<div class="instructions"> To get this output: </div>
8889

8990
<pre>
9091
<code class="hljs language-bash">
91-
test &lt;cmd&gt; [args]
92+
example.js &lt;cmd&gt; [args]
9293

93-
Commands:
94-
hello welcome ter yargs!
94+
Commands:
95+
hello [name] welcome ter yargs!
9596

96-
Options:
97-
--name, -n provide yer name!
98-
--help Show help [boolean]
97+
Options:
98+
--help Show help [boolean]
9999
</code>
100100
</pre>
101101

0 commit comments

Comments
 (0)