From 26459dc47bd91e8a853ea68f28627b209e746d7d Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Mon, 5 Aug 2024 19:29:40 +0200 Subject: [PATCH] Use GitHub admonition syntax for the warning in README --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c96e466e..005c8e72 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # godot-cpp -> **Warning** +> [!WARNING] > > This repository's `master` branch is only usable with > [GDExtension](https://godotengine.org/article/introducing-gd-extensions) @@ -49,18 +49,20 @@ Godot version.** ## Compatibility -**Warning:** The GDExtension API is brand new in Godot 4.0, and is still +> [!WARNING] +> +> The GDExtension API is brand new in Godot 4.0, and is still considered in **beta** stage, despite Godot 4.0 itself being released. - -This applies to both the GDExtension interface header, the API JSON, and this +> +> This applies to both the GDExtension interface header, the API JSON, and this first-party `godot-cpp` extension. - -Some compatibility breakage is to be expected as GDExtension and `godot-cpp` -get more used, documented, and critical issues get resolved. See the -[Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension) -and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues) -for a list of known issues, and be sure to provide feedback on issues and PRs -which affect your use of this extension. +> +> Some compatibility breakage is to be expected as GDExtension and `godot-cpp` +> get more used, documented, and critical issues get resolved. See the +> [Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension) +> and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues) +> for a list of known issues, and be sure to provide feedback on issues and PRs +> which affect your use of this extension. ## Contributing