docs: add a README

Signed-off-by: Raito Bezarius <masterancpp@gmail.com>
This commit is contained in:
raito 2024-09-03 14:52:56 +02:00
parent 9c6d4e5f04
commit 64fee32cc0

15
README.md Normal file
View file

@ -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 <https://github.com/nix-community/nix-eval-jobs>, in the future, it will support as well:
- https://git.lix.systems/lix-project/nix-eval-jobs
- https://cl.tvl.fyi/c/depot/+/12416