Skip to content

Commit

Permalink
docs: update usage info
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesgeorge007 committed Nov 21, 2020
1 parent 3fe2dd3 commit c28c397
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,15 @@ Please note that only those public events that belong to the following list show

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

### Custom commit message or custom maximum number of populated lines
### Override defaults

Specify a custom commit message with the `COMMIT_MSG` input param.
Use the following `input params` to customize it for your use case:-

| Input Param | Default Value | Description |
|--------|--------|--------|
| `COMMIT_MSG` | :zap: Update README with the recent activity | Commit message used while committing to the repo |
| `MAX_LINES` | 5 | The maximum number of lines populated in your readme file |

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

```yml
name: Update README
Expand Down

0 comments on commit c28c397

Please sign in to comment.