diff --git a/README.md b/README.md index 3f35cff..0016213 100644 --- a/README.md +++ b/README.md @@ -10,30 +10,48 @@ Kubernetes resource management with Nix ## Usage -Apply all resources with + -A minimal example flake: +Create a `default.nix` file: + +```nix +{ kubenix ? import (builtins.fetchGit { + url = "https://github.com/hall/kubenix.git"; + rev = "aa734afc9cf7a5146a7a9d93fd534e81572c8122"; +}) }: +(kubenix.evalModules.x86_64-linux { + module = {kubenix, ...}: { + imports = with kubenix.modules; [k8s]; + kubernetes.resources.pods.test.spec.containers.nginx.image = "nginx"; + }; +}).config.kubernetes.result +``` + +Then execute `nix-build` to write JSON manifests to `./result`. + +