Skip to content

Commit 1ed6cf4

Browse files
authored
Merge pull request #43 from tj-actions/chore/update-readme
2 parents df806f7 + 52e5fa8 commit 1ed6cf4

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Analyze node project dependencies using [depcheck](https://github.com/depcheck/d
1313

1414
![sample](https://user-images.githubusercontent.com/17484350/153099924-30a3945a-4094-4a2d-a00e-4dc104644ef2.png)
1515

16-
1716
## Usage
1817

1918
```yaml
@@ -38,8 +37,26 @@ If you feel generous and want to show some extra appreciation:
3837
3938
## Inputs
4039
40+
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
41+
42+
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
43+
|---------|--------|----------|-----------|-----------------------------------------------|
44+
| dir | string | false | `"."` | Directory to perform depcheck |
45+
| ignores | string | false | | Comma separated list of packages<br>to ignore |
46+
| version | string | false | `"1.3.1"` | Provide a version for depcheck<br> |
47+
48+
<!-- AUTO-DOC-INPUT:END -->
49+
4150
## Outputs
4251
52+
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
53+
54+
| OUTPUT | TYPE | DESCRIPTION |
55+
|-----------|--------|--------------------|
56+
| exit\_code | string | depcheck exit code |
57+
58+
<!-- AUTO-DOC-OUTPUT:END -->
59+
4360
## Features
4461
4562
* Runs dependency checks using a specified location.

0 commit comments

Comments
 (0)