Update README.md

Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me>
This commit is contained in:
Dimitris Karakasilis 2023-10-03 16:10:32 +03:00
parent 3142d770cf
commit 71f09dd48c
No known key found for this signature in database
GPG Key ID: 286DCAFD2C97DDE3

View File

@ -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