From 3b418551d089d1bd3c0aee63f903a7d91362eb1d Mon Sep 17 00:00:00 2001
From: Chris Grieser <73286100+chrisgrieser@users.noreply.github.com>
Date: Sat, 28 Dec 2024 12:08:27 +0100
Subject: [PATCH] docs: info on upcoming breaking change & tag for `v0.9`
---
README.md | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/README.md b/README.md
index 598f64c..f40570b 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,19 @@
A lightweight bundle of commands focused on swift and streamlined git
operations.
+> [!NOTE]
+> The upcoming version 1.0 will include several breaking changes. If you want to
+> keep using the current version, pin the tag `v0.9`.
+>
+> ```lua
+> -- lazy.nvim
+> {
+> "chrisgrieser/nvim-tinygit",
+> tag = "v0.9"
+> dependencies = "stevearc/dressing.nvim",
+> },
+> ```
+
