From e0dc9ac31d5d76a5c8c059b34e6fe99e496b5403 Mon Sep 17 00:00:00 2001
From: Gabriel Freitas <gfreitash@gmail.com>
Date: Sun, 22 Jun 2025 19:47:34 -0300
Subject: [PATCH] Update README to document the new `fixed-release-tag-updates`
 optional field

---
 README.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 46260db6..7c55d8cf 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,12 @@ This file stores essential metadata in JSON format. **Make sure you adhere to th
     - Enable this option **only** if your `downloadURL` points to an automatically updating source:
         - **Latest release** (recommended): Using a link to [releases/latest](https://docs.github.com/en/repositories/releasing-projects-on-github/linking-to-releases) 
         - **Latest commit**: Using a link to the [latest commit (HEAD)](https://docs.github.com/en/repositories/working-with-files/using-files/downloading-source-code-archives#source-code-archive-urls)
-        - **Permanent release tag**: Using a link to a specific release tag where you upload new files: `https://github.com/author/repo/releases/tag/my-release-tag`. **(This will always use the latest uploaded file)**.
+- *fixed-release-tag-updates*: (*Optional*) Set to `true` if your mod uses a fixed release tag and still wants to auto-update when modifying the underlying files. This can be useful for repositories with multiple mods, allowing you to have a release tag dedicated for each mod where you upload new versions. Note that:
+  - Requires `automatic-version-check` to also be set to `true`.
+  - Requires that the `version` field is not set as the version will be extracted from the asset's upload date.
+  - The `downloadURL` must point to a specific release asset or a specific release page using a link such: `https://github.com/author/repo/releases/tag/my-release-tag` or `https://github.com/author/repo/releases/download/my-release-tag/mod.zip`. 
+ 
+ 
 
 ### 3. thumbnail.jpg (Optional)
 If included, this image will appear alongside your mod in the index. Maximum and recommended size is 1920x1080 pixels.