From a6a7adfae8b5be0e87688464aeff94d143a2624e Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Fri, 4 Nov 2022 16:05:34 +0100 Subject: [PATCH] document the changelog file in the project's readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 478d4787..a04a3c0b 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,10 @@ Remarks: ## Documentation +We maintain [a detailed changelog for this project](CHANGELOG.md) as well. Please consult the changelog before upgrading to any newer release. + +## Documentation + The Blueprints documentation will be coming soon. For the C++ documentation, since this plugin builds on top of [SGConnect](https://senseglove.gitlab.io/SenseGloveDocs/native/core-api-intro.html#sgconnect) and [SGCoreCpp](https://senseglove.gitlab.io/SenseGloveDocs/native/core-api-intro.html#sgcorecpp) third-party C++ libraries, please refer to [the upstream documentation](https://senseglove.gitlab.io/SenseGloveDocs/native/cpp-reference.html).