diff --git a/README.md b/README.md index 899c40d1..ac96cb22 100644 --- a/README.md +++ b/README.md @@ -48,10 +48,12 @@ This file stores essential metadata in JSON format. **Make sure you adhere to th - **categories**: Must contain at least one of `Content`, `Joker`, `Quality of Life`, `Technical`, `Miscellaneous`, `Resource Packs` or `API`. - **author**: Your chosen username or handle. - **repo**: A link to your mod's repository. -- **downloadURL**: A direct link to the latest version of your released mod. (Can be same as `repo` if no separate download link exists.) -- *folderName*: (*Optional*) The name for the mod's install folder. This must not contain characters `<` `>` `:` `"` `/` `\` `|` `?` `*` -- *version*: (*Optional*, but **recommended**, if `automatic-version-check` disabled) The latest version of your mod. -- *automatic-version-check*: (*Optional*, but **recommended**) Gets the latest release from your mod's repository and updates the `version` field. If there is no release, it will check the latest commit. Set this parameter to `true`, to enable this feature. (Note: the index updates every hour) +- **downloadURL**: A direct link to the latest version of your released mod. Using an automatic link to the [latest release](https://docs.github.com/en/repositories/releasing-projects-on-github/linking-to-releases) is preferred. +- *folderName*: (*Optional*) The name for the mod's install folder. This must be **unique**, and cannot contain characters `<` `>` `:` `"` `/` `\` `|` `?` `*` +- *version*: (*Optional*) The version number of the mod files available at `downloadURL`. +- *automatic-version-check*: (*Optional* but **recommended**) Set to `true` to let the Index automatically update the `version` field. + - Updates happen once every hour, by checking either your mod's latest Release **or** latest commit, depending on the `downloadURL`. + - Enable this option **only** if your `downloadURL` points to an automatically updating source, using a link to [releases/latest](https://docs.github.com/en/repositories/releasing-projects-on-github/linking-to-releases) (recommended), or 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). ### 3. thumbnail.jpg (Optional) If included, this image will appear alongside your mod in the index. Maximum and recommended size is 1920x1080 pixels.