From d228cbba05dfc0cbab9ce11942b56c5d8dac6824 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 22 Jul 2024 23:32:49 +0530 Subject: [PATCH] cleanup: update README --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 53d5d09b..5b941e22 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

ABRoot v2

-

ABRoot is utility which provides full immutability and +

ABRoot is a utility that provides full immutability and atomicity to a Linux system, by transacting between two root filesystems. Updates are performed using OCI images, to ensure that the system is always in a consistent state. It also allows for local atomic changes thanks to @@ -10,9 +10,6 @@ default image.

-> **NOTE**: ABRoot v2 is currently in development. The current stable release -> is v1, which is available in the `v1` branch. - ## Help output ```md @@ -109,7 +106,7 @@ The following table describes each of the configuration options: | `partLabelB` | The label of the partition dedicated to the system's `B` root. | | `partLabelBoot` | The label of the partition dedicated to the master boot. | | `partLabelEfi` | The label of the partition dedicated to the EFI boot. | -| `PartCryptVar` | The encrypted partition to unlock during boot. On a non-lvm setup this would be something like `/dev/nvme1n1p3`. | +| `PartCryptVar` | The encrypted partition to unlock during boot. On a non-lvm setup, this would be something like `/dev/nvme1n1p3`. | | `thinProvisioning` | If set to `true`, ABRoot will use and look for a thin provisioning setup. Check the section about [thin provisioning](#thin-provisioning) for more information. | | `thinInitVolume` | The init volume of the thin provisioning setup. | | `libPathStates` | NOT_IMPLEMENTED | @@ -187,10 +184,10 @@ to have that amount of physical storage. This way, they can provide customers with adequate storage limits and only buy more storage when it's actually needed. -The following schema shows how an ABRoot compatible disk layout would look like +The following schema shows how an ABRoot-compatible disk layout would look like with thin provisioning enabled: ![Thin provisioning schema](assets/lvm-partitioning-structure.png) -To follow-up, have a read at our [blog post](https://vanillaos.org/blog/article/2023-11-22/vanilla-os-orchid---devlog-22-nov) +To follow up, have a read at our [blog post](https://vanillaos.org/blog/article/2023-11-22/vanilla-os-orchid---devlog-22-nov) about thin provisioning in ABRoot.