Skip to content

Commit 9fa98f0

Browse files
committed
docs: document options when used as a lib
1 parent 7844478 commit 9fa98f0

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Prints supported Node.js versions for the package at the git URL.
2626

2727
### Options
2828

29-
* `--deep` - when used with --deps, include direct dev dependencies
29+
* `--deep` - when used with --deps, include indirect dependencies
3030
* `--deps` - include the support information of direct production dependencies
31-
* `--dev` - when used with --deps, include indirect dependencies
31+
* `--dev` - when used with --deps, include dev dependencies
3232

3333
## Usage (library)
3434

@@ -58,7 +58,9 @@ const result = await require('detect-node-support').detect(what, options);
5858

5959
### Options
6060

61+
- `deep: false` - when `true` and used `deps: true`, include indirect dependencies
6162
- `deps: false` - when `true`, include the support information of all dependencies.
63+
- `dev: false` - when `true` and used with `deps: true`, include dev dependencies
6264

6365
### Result
6466

0 commit comments

Comments
 (0)