Skip to content

Commit c28c397

Browse files
docs: update usage info
1 parent 3fe2dd3 commit c28c397

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,15 @@ Please note that only those public events that belong to the following list show
4444

4545
You can find an example [here](https://github.com/jamesgeorge007/jamesgeorge007/blob/master/.github/workflows/update-readme.yml).
4646

47-
### Custom commit message or custom maximum number of populated lines
47+
### Override defaults
4848

49-
Specify a custom commit message with the `COMMIT_MSG` input param.
49+
Use the following `input params` to customize it for your use case:-
50+
51+
| Input Param | Default Value | Description |
52+
|--------|--------|--------|
53+
| `COMMIT_MSG` | :zap: Update README with the recent activity | Commit message used while committing to the repo |
54+
| `MAX_LINES` | 5 | The maximum number of lines populated in your readme file |
5055

51-
Specify a custom maximum number of lines with the `MAX_LINES` input param *(default is 5)*.
5256

5357
```yml
5458
name: Update README

0 commit comments

Comments
 (0)