diff --git a/README.md b/README.md index 8e67ff7..e31dc89 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,15 @@ A GitHub action for styling files with [prettier](https://prettier.io). | Parameter | Required | Default | Description | | - | :-: | :-: | - | -| dry | :x: | false | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. | -| prettier_version | :x: | false | Specific prettier version (by default use latest) | -| prettier_options | :x: | `--write **/*.js` | Prettier options (by default it applies to the whole repository) | +| dry | :x: | `false` | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. | +| prettier_version | :x: | `false` | Specific prettier version (by default use latest) | +| prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) | | commit_options | :x: | - | Custom git commit options | -| same_commit | :x: | False | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2) | -| commit_message | :x: | Prettified Code! | Custom git commit message, will be ignored if used with `same_commit` | -| file_pattern | :x: | * | Custom git add file pattern, can't be used with only_changed! | +| same_commit | :x: | `false` | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2) | +| commit_message | :x: | `"Prettified Code!"` | Custom git commit message, will be ignored if used with `same_commit` | +| file_pattern | :x: | `*` | Custom git add file pattern, can't be used with only_changed! | | branch (depreciated with 3.0)| :white_check_mark: | - | Always set this to `${{ github.head_ref }}` in order to work both with pull requests and push events | -| only_changed | :x: | false | Only prettify changed files, can't be used with file_pattern! This command works only with the checkout action set to fetch depth '0' (see example 2)| +| only_changed | :x: | `false` | Only prettify changed files, can't be used with file_pattern! This command works only with the checkout action set to fetch depth '0' (see example 2)| > Note: using the same_commit option may lead to problems if other actions are relying on the commit being the same before and after the prettier action has ran. Keep this in mind.