From 80757c3a5c14f3f2db8c6169cc5667d5d1f999f1 Mon Sep 17 00:00:00 2001 From: Tycho Bokdam Date: Fri, 18 Oct 2019 11:51:26 +0200 Subject: [PATCH] docs: Updated README --- README.md | 27 ++++++++------------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 72672d3..d032b71 100644 --- a/README.md +++ b/README.md @@ -4,28 +4,15 @@ This action will bump version, tag commit and generate a changelog with conventi ## Inputs -### `github-token` - -**Required** Github token. - -### `git-message` - -**Optional** Commit message that is used when committing the changelog. - -### `preset` - -**Optional** Preset that is used from conventional commits. Default `angular`. - -### `tag-prefix` - -**Optional** Prefix for the git tags. Default `v`. - -### `output-file` - -**Optional** File to output the changelog to. Default `CHANGELOG.md`. +-**Required** `github-token`: Github token. +-**Optional** `git-message`: Commit message that is used when committing the changelog. +-**Optional** `preset`: Preset that is used from conventional commits. Default `angular`. +-**Optional** `tag-prefix`: Prefix for the git tags. Default `v`. +-**Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`. ## Example usage +```yaml - name: Conventional Changelog Action uses: TriPSs/conventional-changelog-action@v0.0.1 with: @@ -34,3 +21,5 @@ This action will bump version, tag commit and generate a changelog with conventi preset: 'angular' tag-prefix: 'v' output-file: 'CHANGELOG.md' + +```