diff --git a/README.md b/README.md index ac96cb22..6e3cb4ac 100644 --- a/README.md +++ b/README.md @@ -49,8 +49,8 @@ This file stores essential metadata in JSON format. **Make sure you adhere to th - **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. Using an automatic link to the [latest release](https://docs.github.com/en/repositories/releasing-projects-on-github/linking-to-releases) is preferred. +- **version**: The version number of the mod files available at `downloadURL`. - *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).