From 81be8b43a8e8508077cdb4e6f1933b505c3e312a Mon Sep 17 00:00:00 2001 From: Adrian Smijulj Date: Thu, 11 Jun 2020 09:50:04 +0200 Subject: [PATCH] chore: update README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index fb882d7..84eb521 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Conventional Commits GitHub Action A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification. + +### Usage + +```yml +name: Build + +on: + pull_request: + branches: [ master ] + +jobs: + build: + name: Conventional Commits + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - uses: webiny/action-conventional-commits@v1.0.1 +```