From 82c4f51df01020ea264be6c398eb3ac8bcae0120 Mon Sep 17 00:00:00 2001 From: Dmytro Hrynevych <5150636+dmh@users.noreply.github.com> Date: Sat, 8 Jul 2023 18:05:54 +0300 Subject: [PATCH] [DOC] update README.md, add screenshots --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b4661ae..ed49600 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,10 @@ * [Changelog generation](#changelog-generation) * [GitHub Release Notes generation](#gitHub-release-notes-generation) * [Quick Release custom config](#quick-release-custom-config) - * [Default settings](#default_settings) - * [Custom settings example #1](#custom_settings_example_1) - * [Custom settings example #2](#custom_settings_example_2) + * [Default settings](#default-settings) + * [Custom settings example #1](#custom-settings-example-1) + * [Custom settings example #2](#custom-settings-example-2) +* [Screenshots](#screenshots) * [Contributing](#contributing) * [Changelog](CHANGELOG.md) @@ -138,7 +139,7 @@ initial commit >* initial commit [`7821b3c`](#) (author_name) #### GitHub Release Notes example based on git-log above with default settings - +GitHub Release Notes example *** @@ -178,6 +179,7 @@ initial commit >* **[!!!]** breaking change commit message [`1f081e1`](#) (author_name) #### GitHub Release Notes example based on git-log above with custom settings #1 +GitHub Release Notes example *** @@ -219,9 +221,16 @@ initial commit >* **BREAKING CHANGE:** breaking change commit message [`1f081e1`](#) (author_name) #### GitHub Release Notes example based on git-log above with custom settings #2 +GitHub Release Notes example *** +## Screenshots +Release type +Choose version +Ready for a new release + + ## Contributing 1. Clone the repository and run `npm link` to install dependencies and create a symlink to the global `node_modules` folder. 2. Now you can run `quick-release` command from any folder to test your changes.