From cee82beb3adee472c3c10992667af2a53095f4e1 Mon Sep 17 00:00:00 2001 From: meriy100 Date: Fri, 12 Jan 2024 14:12:20 +0900 Subject: [PATCH] docs(README): Simple Usage --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a227d8b..003fb8e 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,13 @@ This is a Github Action that verifies that the files generated by the go generate command are up to date. +# Usage + +```yml +# ... +steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 + - ... # If you have any preparation for generate, you need to prepare it. + - uses: pinnacles/validate-go-generate@v0.1.0 +```