From 2db4a7cae5534d5460f665bda463f5aa0e44f901 Mon Sep 17 00:00:00 2001
From: sugoidogo <sugoidogo@sugoidogo.com>
Date: Mon, 22 Dec 2025 04:22:28 -0800
Subject: [PATCH] use workflow to manage licence/readme files

---
 .github/README.md              | 54 ---------------------------------
 .github/workflows/release.yaml |  2 ++
 README.md                      | 55 ++++++++++++++++++++++++++++++++--
 npm-readme.md                  |  3 ++
 package.json                   |  2 +-
 5 files changed, 59 insertions(+), 57 deletions(-)
 delete mode 100644 .github/README.md
 create mode 100644 npm-readme.md

diff --git a/.github/README.md b/.github/README.md
deleted file mode 100644
index 470041b..0000000
--- a/.github/README.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Packwiz Extras
-
-This is a small helper program/library to implement some missing features from
-[packwiz](https://github.com/packwiz/packwiz).
-The CLI is licenced under GPLv3 or later.
-The library is licenced under LGPLv3 or later.
-
-## CLI Usage
-
-```
-Usage: packwiz-extras [options] [command]
-
-extra utilities for packwiz
-
-Options:
-  --pack-file <string>     The modpack file to use (default: "pack.toml")
-  -h, --help               display help for command
-
-Commands:
-  curseforge|cf [options]  manage curseforge files
-  modrinth|mr [options]    manage modrinth files
-  help [command]           display help for command
-```
-curseforge commands:
-```
-Usage: packwiz-extras curseforge|cf [options] [command]
-
-manage curseforge files
-
-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
-  help [command]      display help for command
-```
-modrinth commands:
-```
-Usage: packwiz-extras modrinth|mr [options] [command]
-
-manage modrinth files
-
-Options:
-  --api-key <string>  Your modrinth api key, optional.
-  -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
-  help [command]      display help for command
-```
\ No newline at end of file
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
index b7a6424..f451bc2 100644
--- a/.github/workflows/release.yaml
+++ b/.github/workflows/release.yaml
@@ -24,6 +24,8 @@ jobs:
       - run: npm config set -- '//gitea.sugoidogo.com/api/packages/sugoidogo/npm/:_authToken' "$PACKAGES_KEY"
         env:
           PACKAGES_KEY: ${{ secrets.PACKAGES_KEY }}
+      - run: mv npm-readme.md readme.md
+      - run: mv src/lib/licence.md licence.md
       - run: npm publish
       - run: npm run docs
       - run: npx wrangler deploy
diff --git a/README.md b/README.md
index a5bd1e4..470041b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,54 @@
-Extra functions for managing Packwiz modpacks in JS/TS
+# Packwiz Extras
 
-Documentation is availible at https://packwiz.sugoidogo.com
\ No newline at end of file
+This is a small helper program/library to implement some missing features from
+[packwiz](https://github.com/packwiz/packwiz).
+The CLI is licenced under GPLv3 or later.
+The library is licenced under LGPLv3 or later.
+
+## CLI Usage
+
+```
+Usage: packwiz-extras [options] [command]
+
+extra utilities for packwiz
+
+Options:
+  --pack-file <string>     The modpack file to use (default: "pack.toml")
+  -h, --help               display help for command
+
+Commands:
+  curseforge|cf [options]  manage curseforge files
+  modrinth|mr [options]    manage modrinth files
+  help [command]           display help for command
+```
+curseforge commands:
+```
+Usage: packwiz-extras curseforge|cf [options] [command]
+
+manage curseforge files
+
+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
+  help [command]      display help for command
+```
+modrinth commands:
+```
+Usage: packwiz-extras modrinth|mr [options] [command]
+
+manage modrinth files
+
+Options:
+  --api-key <string>  Your modrinth api key, optional.
+  -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
+  help [command]      display help for command
+```
\ No newline at end of file
diff --git a/npm-readme.md b/npm-readme.md
new file mode 100644
index 0000000..405b35f
--- /dev/null
+++ b/npm-readme.md
@@ -0,0 +1,3 @@
+Extra functions for managing Packwiz modpacks in JS/TS
+
+Documentation is availible at https://packwiz.sugoidogo.com
diff --git a/package.json b/package.json
index 3eddfe4..6ab082f 100644
--- a/package.json
+++ b/package.json
@@ -20,7 +20,7 @@
   "types": "./dist/packwiz.d.ts",
   "files": [
     "dist",
-    "src"
+    "src/lib"
   ],
   "scripts": {
     "test": "node scripts/test.ts",