From 6815e9572510d636b50fe42f983641b4dc5971a3 Mon Sep 17 00:00:00 2001 From: technofab Date: Sun, 24 Nov 2024 19:08:05 +0100 Subject: [PATCH] style(README): format README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a38e5b..493e38f 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,18 @@ Nixlets are kinda like Helm Charts, but they are defined using Kubenix and the N \ One can load Nixlets either via Nix Flakes or by fetching a tarball - ## Usage ### Creating Nixlets + Nixlets need a `default.nix` and a `values.nix` (a `nixlet.nix` containing the metadata is also recommended). \ Check out the existing [nixlets](./nixlets/) to understand how they work. \ There is also a bare-bones [template](./template/). ### Using/rendering Nixlets + To render nixlets you only need to import the nixlets-lib: + ```nix { inputs.nixlet-lib.url = "gitlab:TECHNOFAB/nixlets?dir=lib"; @@ -22,6 +24,7 @@ To render nixlets you only need to import the nixlets-lib: ``` #### Nixlets stored in the Gitlab Package Registry + ```nix (nixlet-lib.fetchNixletFromGitlab { project = "TECHNOFAB/nixlets"; @@ -37,6 +40,7 @@ To render nixlets you only need to import the nixlets-lib: ``` #### Nixlets fetchable from arbitrary URLs + ```nix (nixlet-lib.fetchNixlet "" "").render { # ... @@ -44,7 +48,9 @@ To render nixlets you only need to import the nixlets-lib: ``` #### Metadata + Metadata of the Nixlets can also easily be accessed if needed: + ```nix ().description # version, name, etc. ```