Merge pull request #619 from BastiaanOlij/update_godot_3_info

README.md

@@ -1,27 +1,41 @@
 # godot-cpp
 
-**C++ bindings for the Godot script API.**
+This repository contains the  *C++ bindings* for the [**Godot Engine**](https://github.com/godotengine/godot)'s GDNative API.
-
-The instructions below feature the new NativeScript 1.1 class structure and will only work for modules created for Godot 3.1 and later. Use the following branches for older implementations:
-
-Version | Branch
---- | ---
-**Godot 3.0 Nativescript 1.0** | [3.0](https://github.com/godotengine/godot-cpp/tree/3.0)
-**Godot 3.1 Nativescript 1.0** | [nativescript-1.0](https://github.com/godotengine/godot-cpp/tree/nativescript-1.0)
-
-## Table of contents
 
+- [**Versioning**](#versioning)
 - [**Contributing**](#contributing)
 - [**Getting Started**](#getting-started)
 - [**Creating a simple class**](#creating-a-simple-class)
 
+## Versioning
+
+This repositories follows the same branch versioning as the main [Godot Engine
+repository](https://github.com/godotengine/godot):
+
+- `master` tracks the current development branch.
+- `3.x` tracks the development of the next 3.x minor release.
+- Other versioned branches (e.g. `3.3`, `3.2`) track the latest stable release
+  in the corresponding branch.
+
+Stable releases are also tagged on this repository:
+[**Tags**](https://github.com/godotengine/godot-cpp/tags).
+
+**For any project built against a stable release of Godot, we recommend using
+this repository as a Git submodule, checking out the specific tag matching your
+Godot version.**
+
+> As the `master` and `3.x` branches are constantly getting updates, if you are
+> using `godot-cpp` against a more current version of Godot, see the instructions
+> in [**godot-headers**](https://github.com/godotengine/godot-headers) for
+> updating the relevant files.
+
 ## Contributing
 
 We greatly appreciate help in maintaining and extending this project. If you
 wish to help out, ensure you have an account on GitHub and create a "fork" of
 this repository. Rémi "Akien" Verschelde wrote an excellent bit of documentation
 for the main Godot project on this:
-[Pull request workflow](https://docs.godotengine.org/en/3.0/community/contributing/pr_workflow.html)
+[Pull request workflow](https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html)
 
 Please install clang-format and copy the files in `misc/hooks` into `.git/hooks`
 so formatting is done before your changes are submitted.