From a85b5e6b331f2a452f31b76223cf21ae9b030d20 Mon Sep 17 00:00:00 2001
From: Yousuf Jawwad <yousuf@maher.pk>
Date: Thu, 6 Jun 2024 09:54:53 +0500
Subject: [PATCH] chore(): added github style warning in README.

see https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/
---
 README.md | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5306de5..937436f 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,9 @@
 [![License](https://img.shields.io/github/license/breuHQ/go-temporal-tools)](./LICENSE)
 ![GitHub contributors](https://img.shields.io/github/contributors/breuHQ/go-temporal-tools)
 
+> [!WARNING]  
+> This is a work in porgress. The surface API can change without warning.
+
 ## 🚀 Install
 
 ```sh
@@ -13,8 +16,6 @@ go get go.breu.io/temporal-tools
 
 **Compatibility**: go >= 1.21
 
-- ⚠️ Work in Progress
-
 ## Why?
 
 After working with temporal.io across multiple projects, we have standarized a set of best practices across our projects.