From 64fee32cc05747e05ad24cb510fd910c8d0995ed Mon Sep 17 00:00:00 2001 From: Raito Bezarius Date: Tue, 3 Sep 2024 14:52:56 +0200 Subject: [PATCH] docs: add a README Signed-off-by: Raito Bezarius --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1679aaa --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# evolive + +evolive is a REST API for live evaluations of Nix expressions, geared towards nixpkgs-style repository. + +It provides: + +- a streaming endpoint to dispatch evaluation as we go +- cache evaluations and upload them to a S3 bucket for archival in Parquet files (todo) +- a way to retrieve derivation recipes that were evaluated (todo) +- a way to stream the evaluation log for a given ongoing evaluation (todo) + +Currently, it makes use of , in the future, it will support as well: + +- https://git.lix.systems/lix-project/nix-eval-jobs +- https://cl.tvl.fyi/c/depot/+/12416