From 9a98444ad282b78f3c632a372d81cc45741fcd6e Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 8 Apr 2025 11:03:21 +0200 Subject: [PATCH] Indicate Go API stability in README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index cf53ce2a1..86e516ce7 100644 --- a/README.md +++ b/README.md @@ -435,6 +435,10 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `prNumber`: Pull request number (string, required) - `path`: File or directory path (string, optional) +## Library Usage + +The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable. + ## License This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.