From 2fef1ecff6599da347122ac6fb93fdb42ee9489f Mon Sep 17 00:00:00 2001 From: Casey Link Date: Thu, 31 Oct 2024 18:59:45 +0100 Subject: [PATCH] Improve readme header --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cad8084..699539b 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,20 @@ ️ This flake exposes: -* A `datomic-pro` nix package -* ❄ Several NixOS modules for running Datomic Pro on NixOS -* 🐋 A container image that you can use to run Datomic (no nix required!) - -All of the above are tested automatically with a virtual machine! +* A `datomic-pro` nix package (and `console`, and `peer`) +* ❄ NixOS modules for running Datomic Pro on NixOS +* 🐋 A container image that you can use to run Datomic Pro (no nix required!) +All of the above are [end-to-end tested](./tests) by the CI suite in this repo! **Project status:** Experimental but ready for testing. Breaking changes may occur until version 1.0. The 1.0 release will be considered production-ready. +**Known issues**: + +* The OCI container image is rather fat over 700 MB. -> probably not much more we can do about that +* There's no builtin version pinning yet except for pinning this flake's version. -> this will be fixed before 1.0 + * The last thing you want is for your database to have a surprise upgrade + **Table of Contents**