From 3d43c4c84d5a12ba99d8018a7eb5a0db1dc5fa17 Mon Sep 17 00:00:00 2001 From: Timothy DeHerrera Date: Wed, 7 Aug 2024 16:00:48 -0600 Subject: [PATCH] doc: update usage instructions --- .gitignore | 1 + README.md | 13 ++++++++++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 92b2793..2bbdbfe 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .direnv +result diff --git a/README.md b/README.md index a368967..0011ea4 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,19 @@ code without having to perform a full evaluation. This could be used, e.g. to sh ## Usage +> Note: this is an implementation detail, and the true entrypoint should be considered the TOML manifest file. +> The future cli will honor this and hide this detail from the user. + ```nix let - compose = import ./path/to/this/module/system; - myModule = compose ./path/to/my/atom/root; + atom = builtins.fetchGit "https://github.com/ekala-project/atom"; + fromManifest = import "${atom}/src/atom/fromManifest.nix"; in - myModule +fromManifest { + features = [ + # optional feature flags + ]; +} ./src/dev.toml # or whatever your manifest is called ``` ## Best Practices