Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bcomnes committed May 10, 2024
1 parent 4813571 commit a37654e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Exactly the same as `formatHelpText` except it uses `console.log` to print the t
Generate just the usage string with a given `options` object.
### `headerText = header({ [pkgPath], [name], [headerFn], [exampleFn] })
### `headerText = header({ [pkgPath], [name], [headerFn], [exampleFn] })`
Generate the headerText only. Pass in either a `pkgPath` string path to the `package.json` of the bin you are printing for, or a `name`. The `headerFn` and `exampleFn` allow you to override the header text that is generated. Each function receilves an object with a `name` key.
Expand Down

0 comments on commit a37654e

Please sign in to comment.