From c28c39731090689cf66b896925bfc03f7267a95d Mon Sep 17 00:00:00 2001 From: jamesgeorge007 Date: Sat, 21 Nov 2020 13:19:06 +0530 Subject: [PATCH] docs: update usage info --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5a3b841..a3969af 100644 --- a/README.md +++ b/README.md @@ -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