From 9e277a1685736cafc489346e41ba9ca1dbbad306 Mon Sep 17 00:00:00 2001 From: AzraelSec Date: Tue, 12 Dec 2023 16:30:21 +0100 Subject: [PATCH] docs: add warnings on `README.md` file --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index a456bc6..38c02fd 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,13 @@ Welcome to Glock, the ultimate tool for managing your multi-repository projects Glock is a powerful open-source project developed in Go, designed to assist teams in managing the development of their multi-repository projects. It offers a range of handy commands that streamline versioning, stack execution, and other useful operations. With Glock, you can bid farewell to those tedious manual tasks and embrace a smoother, more efficient workflow. +> [!WARNING] +> Please keep in mind that Glock is still under active development +> and therefore backward compatibility is not guaranteed and breaking changes are expected. + +> [!NOTE] +> There is still no documentation on Glock configuration. It'll be produced and published as soon as possible. + ## Key Features - **Effortless Versioning:** Glock makes version management a breeze, allowing you to easily handle multiple repositories and their associated versions. Say goodbye to versioning conflicts and hello to seamless collaboration.