diff --git a/README.md b/README.md index 04ca0cc..e33fbd3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # generate-assets GitHub Action that generates Minecraft default resourcepack assets. + +## Usage + +### Inputs 📥 + +| Input | Required? | Default | Description | +| --------------- | --------- | ----------------------------------------------------------------- | ---------------------------------------------------------- | +| `version` | `true` | | Minecraft version to generate assets for. | +| `path` | `false` | `./default` | Relative path under $GITHUB_WORKSPACE to place the assets. | +| `api-url` | `false` | `https://piston-meta.mojang.com/mc/game/version_manifest_v2.json` | URL to the Minecraft manifest API. | +| `resources-url` | `false` | `https://resources.download.minecraft.net` | URL to the Minecraft resources API. |