From a1ce40252f6121a184f6441e20cf88a8b1e0f91d Mon Sep 17 00:00:00 2001
From: Niklas Widmann <nik@somethingcatchy.net>
Date: Thu, 24 Nov 2022 14:41:54 +0100
Subject: [PATCH] Add README.md

---
 README.md    | 33 +++++++++++++++++++++++++++++++++
 package.json |  2 +-
 2 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 README.md

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": {