From 1a5e73c902100257bea4a868ff33183c38d7a2c7 Mon Sep 17 00:00:00 2001 From: Stephen Zhou Date: Tue, 26 Mar 2024 19:25:58 +0800 Subject: [PATCH] docs: Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index f892d2f..bac1494 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Run [release-it](https://github.com/release-it/release-it) with [pnpm](https://p ni -D release-it release-it-pnpm ``` -Generate the recommended config, it will create or overwrite `.release-it.json` and `.github/workflows/release.yml` files. +Generate the recommended config, it will create or overwrite `.release-it.json` and `.github/workflows/release.yml` (guard with [should-semantic-release](https://github.com/JoshuaKGoldberg/should-semantic-release)) files. ```sh npx release-it-pnpm @@ -57,8 +57,6 @@ npx release-it --preRelease=alpha 1. appendix `--tag {tag}` if it's a prerelease 1. Run `npx changelogithub` for GitHub release ([changelogithub](https://github.com/antfu/changelogithub)) -Guard with [should-semantic-release](https://github.com/JoshuaKGoldberg/should-semantic-release) - [npm-version-src]: https://img.shields.io/npm/v/release-it-pnpm?style=flat&colorA=080f12&colorB=1fa669