diff --git a/README.md b/README.md index b668e21..1763dfa 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # zlevis-dracut -A dracut module that implements automatic decryption of a `ZFS` root pool in the `initramfs` with `zlevis`. +A [dracut](https://dracut-ng.github.io/dracut-ng/) module that implements automatic decryption of a `ZFS` root pool in the `initramfs` with `zlevis`. + +## Installation + +`zlevis-dracut` can be installed with `meson`, after cloning the repository, setup the build directory: + +``` +$ meson setup builddir +``` + +> Using the `--reconfigure` flag will reconfigure the build directory. + +Installation of the `zlevis-dracut` module is now performed with: + +``` +# meson install -C builddir +```