From 6c816508fbfc876cf1cc389eb8bb800553a8e2f9 Mon Sep 17 00:00:00 2001
From: seth <getchoo@tuta.io>
Date: Fri, 12 May 2023 06:27:50 -0400
Subject: docs: add maintainer guide to document more advanced functions

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3410592..c440d3b 100644
--- a/README.md
+++ b/README.md
@@ -75,6 +75,40 @@ packwiz2nix is quick to set up, all you have to do is add this to the `apps` att
 
 An example of this can be found in my [personal modpack](https://github.com/getchoo/modpack/blob/main/flake.nix)
 
+## Maintainer Guide
+
+packwiz2nix also offers some more advanced features if maintainers wish to integrate
+this project further into their distribution.
+
+### Create traditional modpacks
+
+One of these features is the ability to create traditional modpacks anyone can use. So far,
+only modpacks for MultiMC and Prism Launcher are supported.
+
+#### MultiMC/Prism Launcher
+
+`mkMultiMCPack` allows you to create a package attribute that will result in a zipfile any user of
+Prism Launcher and MultiMC can import. For example:
+
+```nix
+{
+  packages = let
+    inherit (packwiz2nix.lib) mkMultiMCPack mkPackwizPackages;
+    mods = mkPackwizPackages pkgs ./checksums.json;
+  in rec {
+    myModpack = mkMultiMCPack {
+      inherit pkgs mods;
+      # optionally include external
+      # files in modpack
+      filesDir = ./files;
+      name = "myModpack";
+    };
+
+    default = myModpack;
+  };
+}
+```
+
 ## Gotchas!
 
 There are two main things you should keep in mind with this project currently:
-- 
cgit v1.2.3