From a88694e43d5a1f3a299f9aef7b99fb6b33872aac Mon Sep 17 00:00:00 2001 From: openhands Date: Thu, 30 Oct 2025 18:33:59 +0000 Subject: [PATCH] Add alpha software warning to README - Add prominent warning at top of README indicating this is alpha software - Warn users about potential breaking changes and instability - Advise against production use - Include specific warnings about incomplete features and documentation --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 9de7345..20442d3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # OpenHands Agent Server TypeScript Client +> ⚠️ **ALPHA SOFTWARE WARNING** ⚠️ +> +> This TypeScript SDK is currently in **alpha** and is **not stable**. The API may change significantly between versions without notice. This software is intended for early testing and development purposes only. +> +> - Breaking changes may occur in any release +> - Features may be incomplete or contain bugs +> - Documentation may be outdated or incomplete +> - Not recommended for production use +> +> Please use with caution and expect frequent updates. + A TypeScript client library for the OpenHands Agent Server API that mirrors the structure and functionality of the Python SDK. ## Features