@@ 0,0 1,52 @@
+# Nix fetcher for Minetest ContentDB
+
+**Install and update your minetest mods with a nix flake**
+
+## Usage
+
+First, [install nix](https://nixos.org/download) and [enable flakes](https://nixos.wiki/wiki/Flakes).
+
+Then, install `nix-mt`, which is just a wrapped nix with the fetcher plugin
+
+```sh
+nix profile install sourcehut:~fgaz/nix-minetest-fetcher#nix-mt
+```
+
+Create a project from [the template](./example/flake.nix)
+
+```sh
+mkdir my-server-mods
+cd my-server-mods
+nix flake init -t sourcehut:~fgaz/nix-minetest-fetcher
+```
+
+Finally, build the project using the patched nix
+
+```sh
+nix-mt build
+```
+
+## Known issues
+
+* Packages whose zip contains multiple top-level items will fail to install.
+ See [nix#7083](https://github.com/NixOS/nix/issues/7083).
+* The protocol ("x-minetest-contentdb") is provisional and may change in the
+ future if [minetest#7400](https://github.com/minetest/minetest/issues/7400)
+ is closed.
+
+## Alternatives
+
+* The ContentDB browser included in Minetest
+* [minetools](https://github.com/ronoaldo/minetools)
+
+Both of these are imperative and require the packages to remain on disk to track their versions, since they both use the `release` `.conf` field.
+
+## Contributing
+
+You can send patches to my
+[public-inbox mailing list](https://lists.sr.ht/~fgaz/public-inbox)
+or to any of the contacts listed at [fgaz.me/about](https://fgaz.me/about).
+Or you can send a pull request to the
+[Codeberg mirror](https://codeberg.org/fgaz/nix-minetest-fetcher).
+
+Issues are tracked at https://todo.sr.ht/~fgaz/nix-minetest-fetcher