From fafb236bb1fcd16b6e3971677638457b1f05e41a Mon Sep 17 00:00:00 2001 From: Dennis ten Hoove Date: Sat, 23 Mar 2024 14:01:51 +0100 Subject: [PATCH] Update README --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ac031f..0c84294 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # Arkdep Toolkit for building, deploying and maintaining an immutable, btrfs-based, multi-root system. -Arkdep attempts to be as simple to use as possible and avoid unnecessary abstraction, if you know how to use GNU/Linux picking up Arkdep should be painless for it maintains much of your old familiar workflow. +> [!NOTE] +> Arkdep is still in active development, no more breaking changes are planned since all core functionality is now in, however breaking changes might still happen as the project moves toward stable. The current codebase has also yet to be thoroughly tested, there may be lingering bugs or other issues -> [!WARNING] -> Arkdep is still in active development, no more breaking changes are planned since all core functionality is now in, however the current codebase has yet to be thoroughly tested, there may be lingering bugs or other issues +## About +Arkdep is the set of tools providing immutability to Arkane Linux. It attempts to differentiate itself from other similar tools by being "stupidly simple", hackable, flexible, and having the usability of the tooling be a top priority. ## Documentation and usage For documentation refer to the [Arkane Linux Arkdep Documentation](https://docs.arkanelinux.org/arkdep/arkdep/), or the Markdown documents over on either [GitHub](https://github.com/arkanelinux/docs.arkanelinux.org/tree/main/docs/arkdep) or [Codeberg](https://codeberg.org/arkanelinux/docs.arkanelinux.org/src/branch/main/docs/arkdep).