From 38318587e03154dc601bb181d7bb7045c7bbd920 Mon Sep 17 00:00:00 2001 From: Aram Drevekenin Date: Fri, 5 Jul 2024 16:14:07 +0200 Subject: [PATCH] docs(readme): warning about pre-release versions --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index be7c8ccf..38e51307 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,11 @@ fish/xonsh: bash -c 'bash <(curl -L zellij.dev/launch)' ``` +#### Installing from `main` +Installing Zellij from the `main` branch is not recommended. This branch represents pre-release code, is constantly being worked on and may contain broken or unusable features. In addition, using it may corrupt the cache for future versions, forcing users to clear it before they can use the officially released version. + +That being said - no-one will stop you from using it (and bug reports involving new features are greatly appreciated), but please consider using the latest release instead as detailed at the top of this section. + ## How do I start a development environment? * Clone the project