From d4bf155867eac8e55c487ff84c77ba83d6372166 Mon Sep 17 00:00:00 2001 From: Brian Ketelsen Date: Mon, 20 Mar 2023 22:33:13 -0400 Subject: [PATCH] chore: update readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index a17b00bc..f1812cb6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Fleek is an all-in-one management system for everything you need to be productive on your computer. +Status: ALPHA. Probably won't eat your computer. Probably won't break your system, at least beyond simple recoverability. Will definitely eat your dotfiles... by design. `fleek` will backup dotfiles it replaces. + ## Instant Productivity Fleek takes you from an empty slate to a fully productive working environment in less than five minutes. @@ -25,3 +27,9 @@ If you reach a point where you've grown beyond Fleek's opinions and you want mor ## Party in the Front, Business in the Back Fleek is a user-friendly wrapper around Nix and Nix Home Manager, but the friendly `fleek` command hides all the complexity from you. Edit a 10 line YAML file and Fleek harnesses the power of Nix behind the scenes. + +### Getting Started + +You need `nix`. We love the [Determinate Systems Installer](https://zero-to-nix.com/), but any `nix` is good. If you're on Fedora Silverblue [this script](https://github.com/dnkmmr69420/nix-with-selinux/blob/main/silverblue-installer.sh) is the good stuff. + +Next you'll need `fleek`. Download from the releases link.