From 71f09dd48cebbe4b5f3aeed9e1677819e6e289c5 Mon Sep 17 00:00:00 2001 From: Dimitris Karakasilis Date: Tue, 3 Oct 2023 16:10:32 +0300 Subject: [PATCH] Update README.md Signed-off-by: Dimitris Karakasilis --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 402eb25..1d42b6d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -This is enki +`enki` is the tool used to generate Kairos artifacts (container images, isos etc) and it is used +by [`Auroraboot`](https://kairos.io/docs/reference/auroraboot/) and [osbuilder](https://github.com/kairos-io/osbuilder/) + +It's not meant to be used by humans, thus the API and UX are not focusing on user friendliness but +rather on getting things done and fulfilling the requirements of the dependant tools. NOTE: `enki` was originally part of [osbuilder](https://github.com/kairos-io/osbuilder/) and [was moved to a separate repository](link to PR here). - -TODO: Add more information about enki