add readme, update repo link

This commit is contained in:
2026-02-17 18:06:27 -08:00
parent aa37c81e8e
commit 98bb8d54cd
2 changed files with 38 additions and 0 deletions
+31
View File
@@ -0,0 +1,31 @@
# Packwiz Extras
This is a small library and cli program providing a few extra utilities for packwiz modpacks
# Usage
```
packwiz-extras [options] [command]
Options:
--pack-file <string> The modpack file to use (default: "pack.toml")
packwiz-extras modrinth|mr [options] [command]
Options:
-h, --help display help for command
Commands:
detect detect and replace files availible on modrinth
merge detect curseforge metafiles which are also availible on modrinth and merge their metadata
packwiz-extras curseforge|cf [options] [command]
Options:
--api-key <string> Your curseforge api key. This is required by curseforge to access their API. Can also be provided via environment variable or .env file as CF_API_KEY
-h, --help display help for command
Commands:
detect detect and replace files availible on curseforge
urls cache curseforge download urls to speed up packwiz-installer
```
+7
View File
@@ -5,11 +5,18 @@
"keywords": [
"minecraft"
],
"repository": {
"type": "git",
"url": "https://gitea.sugoidogo.com/sugoidogo/packwiz-extras.git"
},
"license": "LGPL-3.0-or-later",
"author": "SugoiDogo",
"type": "module",
"main": "dist/index.js",
"types": "./dist/index.d.ts",
"directories": {
"doc": "docs"
},
"files": [
"dist",
"src"