diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..0315c7f --- /dev/null +++ b/README.adoc @@ -0,0 +1,60 @@ +:showtitle: +:toc: left +:icons: font + += PatOS - Patagia OS + +[link=https://ci.patagia.dev/repos/2,window=_blank] +image::https://ci.patagia.dev/api/badges/2/status.svg[Build Status] + +PatOS is a minimal, immutable Linux distribution specialized for the Patagia Platform. + +== Features + +* Immutable read-only system +* Trust chain verification using secure boot and dm-verity +* Automatic updates and unattended rollbacks +* Host/TPM bound data encryption by default + +== Roadmap and status + +[cols="3,1",options="header"] +|=== +|Feature |Status + +| A/B root partitions with discoverable partitions +| ✅ + +| Verity protection of root partitions +| ✅ + +| Encrypted state partition with tpm2 host binding +| ✅ + +| Factory reset / clearing of state partition +| ✅ + +| Automatic updates +| ⚠️ + +| Installer +| ❌ + +| Machine registration and provisioning +| ❌ + +| Boot assessment w/automatic rollback +| ❌ + +|=== + +== Community + +* Source code: https://patagia.dev/Patagia/patos + + +== License + +Copyright (C) 2024 Patagia AB + +Unless otherwise noted, all components are licenced under the Mozilla Public License Version 2.0. diff --git a/README.md b/README.md deleted file mode 100644 index 795340f..0000000 --- a/README.md +++ /dev/null @@ -1,35 +0,0 @@ -# PatOS - Patagia OS - -[![status-badge](https://ci.patagia.dev/api/badges/2/status.svg)](https://ci.patagia.dev/repos/2) - -PatOS is a minimal, immutable Linux distribution specialized for the Patagia Platform. - -## Features - -* Immutable read-only system -* Trust chain verification using secure boot and dm-verity -* Automatic updates and unattended rollbacks -* Host/TPM bound data encryption by default - -## Roadmap and status - -| Step | Status | -| --------------------------------------------------------- | :----: | -| A/B root partitions with discoverable partitions | ✅ | -| Verity protection of root partitions | ✅ | -| Encrypted state partition with tpm2 host binding | ✅ | -| Automatic updates | ⚠️ | -| Installer | ❌ | -| Machine registration and provisioning | ❌ | -| Boot assessment w/automatic rollback | ❌ | - -## Community - -* Source code: https://patagia.dev/Patagia/patos - - -## License - -Copyright 2024 Patagia - -Unless otherwise noted, all components are licenced under the Mozilla Public License Version 2.0.