diff --git a/README.md b/README.md new file mode 100644 index 0000000..e39cea3 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +[web]: https://packs.macarena.ceo + +# Modpack CLI + +## Usage + +Update assets & pages on the [Web Index][web] + +```sh +pack web --web-token ******* +``` + +Create a release [Web Index][web] + +```sh +pack web + --web-token ******* \ + --version 1.0.0 \ + --author me \ + --changelog "Initial Release" \ +``` + +Create a release [Web Index][web] & Curseforge + +```sh +pack web curseforge + --web-token ******* \ + --version 1.1.0 \ + --author me \ + --changelog "Minor Patches" \ + --curseforge-token ******* \ + --curseforge-project 123456 \ +``` diff --git a/package.json b/package.json index e94b2a8..ff233d8 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@voidshake/modpack-cli", "version": "0.0.0-dev", - "description": "Modpack CLI", + "description": "CLI to release modpacks", "main": "dist/index.js", "exports": "./dist/index.js", "bin": {