From 3fdeef0fad7927c1f31d2826845762364d5ab8f6 Mon Sep 17 00:00:00 2001
From: Jan Nanista
Date: Thu, 25 Jan 2024 14:58:02 -0800
Subject: [PATCH] chore: Beta release banner
---
README.md | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 16c182e94..005c8d098 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,12 @@
Development | Cheatsheet | Examples
+---
+
+**Please note** that this repository is in a **beta** state and backwards-incompatible changes might be introduced in future releases. While we strive to comply to [semver](https://semver.org/), we can not guarantee to avoid breaking changes in minor releases.
+
+---
+
## Introduction
This toolkit is designed to streamline the process of building, testing, and deploying omnichain applications (OApps) using LayerZero. This tool is meant to support you through the end-to-end development lifecycle of a cross-chain project.
@@ -36,7 +42,7 @@ Our example project offers templates for both the Hardhat and Foundry frameworks for writing and running unit tests for your LayerZero contracts.
+Testing your contracts is crucial. We support both Hardhat and Foundry frameworks for writing and running unit tests for your LayerZero contracts.
Use `npx hardhat compile` or `forge build` to compile your smart contracts.
@@ -69,6 +75,7 @@ npx hardhat lz:oapp:wire
By following these steps, you can focus more on creating innovative omnichain solutions and less on the complexities of cross-chain communication.
+
Join our community on Discord | Follow us on Twitter