diff --git a/README.md b/README.md index 7491442..c87e8c7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +![Example of profile README](https://raw.githubusercontent.com/theboi/github-update-readme/master/example.png) + ## About This GitHub Action updates your profile README.md to show your latest activity. @@ -10,15 +12,15 @@ This GitHub Action updates your profile README.md to show your latest activity. ### `header` -**Required** The header of your README.md. +**Required** The header of your README.md. Markdown supported. ### `subhead` -The subheader of your README.md. Default `""`. +The subheader of your README.md. Markdown supported. Default `""`. ### `footer` -The footer of your README.md. Default `""`. +The footer of your README.md. Markdown supported. Default `""`. ### `path` @@ -34,7 +36,9 @@ Number of repositories to load per row. Default `"3"`. ### `customReadmeFile` -Customise the README.md file format without forking this repository. Use these reserved strings wrapped in `${` and `}` (For instance, `${header}`) to reference certain content: +Customise the README.md file format without forking this repository. Markdown supported. + +Use these reserved strings wrapped in `${` and `}` (For instance, `${header}`) to reference certain content: - `repoTable`: Set of tables with most recent repository activity. - `header` - `subhead` diff --git a/action.yml b/action.yml index 1ed7bf7..fec26bf 100644 --- a/action.yml +++ b/action.yml @@ -2,15 +2,15 @@ name: 'github-update-readme' description: 'Update your profile README.md to show your latest activity.' inputs: header: - description: 'The header of your README.md.' + description: 'The header of your README.md. Markdown supported.' required: true default: '' subhead: - description: 'The subheader of your README.md.' + description: 'The subheader of your README.md. Markdown supported.' required: false default: '' footer: - description: 'The footer of your README.md.' + description: 'The footer of your README.md. Markdown supported.' required: false default: '' path: @@ -26,7 +26,7 @@ inputs: required: false default: '3' customReadmeFile: - description: "Customise the README.md file format without forking this repository. Read more on this repository's README.md" + description: "Customise the README.md file format without forking this repository. Read more on this repository's README.md. Markdown supported." required: false default: | ## ${header} diff --git a/example.png b/example.png new file mode 100644 index 0000000..f5ef6fc Binary files /dev/null and b/example.png differ