diff --git a/README.md b/README.md index 438b009..4aa8b5f 100644 --- a/README.md +++ b/README.md @@ -222,7 +222,7 @@ For advanced use cases additional settings can be provided to the action ### PR Template placeholders -Table of supported placeholders allowed to be used in the `pr_template` configuration. +Table of supported placeholders allowed to be used in the `pr_template` configuration, which will be included in the release notes / changelog. | **Placeholder** | **Description** | |------------------|-------------------------------------------------------------| @@ -239,7 +239,7 @@ Table of supported placeholders allowed to be used in the `pr_template` configur ### Template placeholders -Table of supported placeholders allowed to be used in the `template` and `empty_template` (only supports placeholder marked for empty) configuration. +Table of supported placeholders allowed to be used in the `template` and `empty_template` (only supports placeholder marked for empty) configuration, to give additional control on defining the contents of the release notes / changelog. | **Placeholder** | **Description** | **Empty** | |----------------------------|----------------------------------------------------------------------------------------------------|:---------:| @@ -257,7 +257,7 @@ Table of supported placeholders allowed to be used in the `template` and `empty_ ### Configuration Specification -Table of descriptions for the `configuration.json` options. +Table of descriptions for the `configuration.json` options to configure the resulting release notes / changelog. | **Input** | **Description** | |--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -336,7 +336,7 @@ All patches and changes applied to the original source are licensed under the Ap See the License for the specific language governing permissions and limitations under the License. -## Sample result changelog +## Sample result release notes / changelog