diff --git a/README.md b/README.md index d5806a21..f4cfdf8d 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,76 @@ nix build The built resume will end up in `./result`. +Additionally, this project's flake overlay output exposes the function +`pandocResume.buildResume` for building a resume stored somewhere other than +[the default location](#instructions): + +```nix +{ + description = "Flake for building my resume"; + + inputs = { pandoc_resume.url = "github:mszep/pandoc_resume"; }; + + outputs = { self, nixpkgs, pandoc_resume }: + { + packages.x86_64-linux = + let + pkgs = import nixpkgs { system = "x86_64-linux"; overlays = [ pandoc_resume.overlays.pandocResume ]; }; + + myResume = pkgs.pandocResume.buildResume { + # Mandatory. + # + # Must specify a directory containing a resume whose basename + # includes the extension `.md`. + inDir = "${self}/my-resume"; + + # Optional. + # + # The specified directory must contain the files `