Include README in Sphinx using the include directive (#316)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

README.md

@@ -1,9 +1,4 @@
-> [!CAUTION]
-> scikit-gmsh is in the pre-alpha stage. The interface could be subject to significant changes soon.
-
-# scikit-gmsh
-
-[<img src="https://raw.githubusercontent.com/pyvista/scikit-gmsh/main/docs/_static/logo.svg" align="left" width="200">](https://github.com/pyvista/scikit-gmsh#--------)
+[<img src="https://raw.githubusercontent.com/pyvista/scikit-gmsh/main/docs/_static/logo.svg" align="center" width="200">](https://github.com/pyvista/scikit-gmsh#--------)
 
 > Scikit for Gmsh to generate 3D finite element mesh.
 
@@ -12,16 +7,14 @@
 [![GitHub Repo stars](https://img.shields.io/github/stars/pyvista/scikit-gmsh)](https://github.com/pyvista/scikit-gmsh/stargazers)
 [![Documentation Status](https://readthedocs.org/projects/scikit-gmsh/badge/?version=latest)](https://scikit-gmsh.readthedocs.io/en/latest/?badge=latest)
 
+The `sikit-gmsh` package provides a simple interface to the `gmsh` library.
+
 Contributions are _very welcome_ .
 This project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
 By participating in this project, We want you to know that you agree to follow its terms.
 
----
-
 Enjoying scikit-gmsh? Show your support with a [GitHub star](https://github.com/pyvista/scikit-gmsh) — it’s a simple click that means the world to us and helps others discover it, too! ⭐️
 
----
-
 ## Installation
 
 [![pypi](https://img.shields.io/pypi/v/scikit-gmsh?label=pypi&logo=python&logoColor=white)](https://pypi.org/project/scikit-gmsh/)

docs/index.md

@@ -1,12 +1,8 @@
-# 🚧 scikit-gmsh documentation
+# scikit-gmsh documentation
 
-:::{note}
-We've marked content with a 🚧 to indicate that it's still under construction.
-:::
+```{include} ../README.md
 
-## 🚧 Overview
-
-The `sikit-gmsh` package provides a simple interface to the `gmsh` library.
+```
 
 ## Contributors