chore: update the README.md

Incendo · Nov 27, 2023 · 949dbf0 · 949dbf0
1 parent 142f4c9
commit 949dbf0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,6 @@
-# cloud-docs
-Documentation for Cloud v2
+# cloud-docs [![Documentation Status](https://readthedocs.org/projects/incendocloud/badge/?version=latest)](https://cloud.incendo.org/en/latest/?badge=latest)
+
+Documentation for Cloud v2.
+The docs are written in markdown using [MkDocs](https://www.mkdocs.org/).
+The docs are automatically built & deployed when pushing to the `main` branch and the docs are available on [cloud.incendo.org](https://cloud.incendo.org).
+Each PR will deploy a temporary preview version of the site.
diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,3 @@
 # Cloud
 
 Hello :)
-
-This is a very important change!