summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2024-08-05 19:29:40 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2024-08-05 19:31:32 +0200
commit26459dc47bd91e8a853ea68f28627b209e746d7d (patch)
treec7877aa7dc0ed0260192115f34de40f7f7a50f9c /README.md
parentdaf6ad3649898e019baeeefafd05d0390e9f78bd (diff)
downloadredot-cpp-26459dc47bd91e8a853ea68f28627b209e746d7d.tar.gz
Use GitHub admonition syntax for the warning in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/README.md b/README.md
index c96e466..005c8e7 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