Skip to content
This repository has been archived by the owner on Dec 16, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me>
  • Loading branch information
jimmykarily committed Oct 3, 2023
1 parent 3142d77 commit 71f09dd
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)

NOTE: `enki` was originally part of [osbuilder](https://github.com/kairos-io/osbuilder/) and [was moved to a separate repository](link to PR here).
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.

TODO: Add more information about enki
NOTE: `enki` was originally part of [osbuilder](https://github.com/kairos-io/osbuilder/) and [was moved to a separate repository](link to PR here).

0 comments on commit 71f09dd

Please sign in to comment.