diff --git a/README.md b/README.md index 46bf78d..8635732 100644 --- a/README.md +++ b/README.md @@ -216,22 +216,23 @@ _Example3 (with breaking message):_ You can configure the action with various inputs, a list of which has been provided below: -| Name | Description | Default Value | -|------------------|-------------------------------------------------------------------------------------------------|---------------| -| tool-version | The version of the tool to run | latest | -| release-branch | The name of the master/main branch | master | -| dev-branch | The name of the development branch | dev | -| skip-prerelease | Skip prerelease part of the version. When true, release-branch and dev-branch are effectively ignored | false | -| minor-identifier | The string used to identify a minor release (wrap with '/' to match using a regular expression) | feature: | -| major-identifier | The string used to identify a major release (wrap with '/' to match using a regular expression) | breaking: | -| prefix | The prefix used for the version name | | -| log-paths | The paths used to calculate changes (comma-separated) | | +| Name | Description | Default Value | +| ---------------- | ----------------------------------------------------------------------------------------------------- | ------------- | +| tool-version | The version of the tool to run | latest | +| release-branch | The name of the master/main branch | master | +| dev-branch | The name of the development branch | dev | +| skip-prerelease | Skip prerelease part of the version. When true, release-branch and dev-branch are effectively ignored | false | +| minor-identifier | The string used to identify a minor release (wrap with '/' to match using a regular expression) | feature: | +| major-identifier | The string used to identify a major release (wrap with '/' to match using a regular expression) | breaking: | +| prefix | The prefix used for the version name | | +| log-paths | The paths used to calculate changes (whitespace-separated) | | ## Requirements To use this tool you will need to install a few dependencies: Ubuntu: + ``` sudo apt-get install \ libevent-dev \