From 3355e6295746f69f5465d6e92636ef5c9b81517c Mon Sep 17 00:00:00 2001 From: Phill Sparks Date: Wed, 22 Apr 2020 16:21:33 +0100 Subject: [PATCH] Improve README for marketplace Make it clear that we're using `elm-format --validate` (not automatically accepting the formatting) --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 42b1ef0..3abcde8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ [![elm-format-action status](https://github.com/sparksp/elm-format-action/workflows/build-test/badge.svg)](https://github.com/sparksp/elm-format-action/actions) -# Elm Format Action for GitHub Workflows +# elm-format --validate + +Validate your [Elm] files using [elm-format] - any unformatted files will cause the check to fail and a note will be added to each failing file. + +[Elm]: https://elm-lang.org/ +[elm-format]: https://github.com/avh4/elm-format + +## Finding elm-format You must have `elm-format` available in your build, here is an example where elm-format is in `package.json`. @@ -46,4 +53,4 @@ This action supports file globs using [@actions/glob]. elm-format will process elm_glob: true ``` -[@actions/glob]: https://github.com/actions/toolkit/tree/master/packages/glob#patterns \ No newline at end of file +[@actions/glob]: https://github.com/actions/toolkit/tree/master/packages/glob#patterns