From 8e1879ebda580e150ef1c1db6853140c3cd8f467 Mon Sep 17 00:00:00 2001
From: hndrk <51416554+hendriknielaender@users.noreply.github.com>
Date: Thu, 2 Nov 2023 23:35:13 +0100
Subject: [PATCH] chore: update README.md

add compatibility notes
---
 README.md | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 705276f..15e3327 100644
--- a/README.md
+++ b/README.md
@@ -41,8 +41,13 @@ zvm --help              # Displays help information
 zvm --version           # Display zvm version
 ```
 
-## Contributing
+### Compatibility Notes
+Zig is in active development and the APIs can change frequently, making it challenging to support every dev build. This project currently aims to be compatible with stable, non-development builds to provide a consistent experience for the users.
+
+***Supported Version***: As of now, zvm is tested and supported on Zig version ***0.11.0***.
+
+### Contributing
 Contributions, issues, and feature requests are welcome!
 
-## Clarification
+### Clarification
 Please note that our project is **not** affiliated with [ZVM](https://github.com/tristanisham/zvm) maintained by @tristanisham. Both projects operate independently, and any similarities are coincidental.