From b97a1c5017c700b56c444530845dbf1afce38687 Mon Sep 17 00:00:00 2001
From: Stephen Zhou <hi@hyoban.cc>
Date: Thu, 18 Apr 2024 19:01:22 +0800
Subject: [PATCH] docs: mention tagName

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 025fcee..c9f98c7 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,16 @@ Check files content at [.release-it.json](./src/bin/release-it.txt) and [.github
 release-it-pnpm
 ```
 
+By default, release-it will not add a `v` prefix for the tag name, useless there already is one tag with the `v` prefix. You can explicitly set the `tagName` in `.release-it.json`:
+
+```json
+{
+	"git": {
+		"tagName": "v${version}"
+	}
+}
+```
+
 > [!TIP]
 > guard with [should-semantic-release](https://github.com/JoshuaKGoldberg/should-semantic-release)