doc: include README in the documentation

Author: azmeuk

README.md

@@ -1,3 +1,3 @@
-# scim-cli [![Documentation Status](https://readthedocs.org/projects/scim-cli/badge/?version=latest)](https://scim-cli.readthedocs.io/en/latest/?badge=latest) ![Unit tests](https://github.com/yaal-coop/scim-cli/actions/workflows/tests.yaml/badge.svg)
+# scim-cli
 
 A scim utility command line.

doc/conf.py

@@ -25,6 +25,11 @@
 year = datetime.datetime.now().strftime("%Y")
 copyright = f"{year}, Yaal Coop"
 author = "Yaal Coop"
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
+}
 
 version = metadata.version("scim_cli")
 language = "en"
@@ -51,6 +56,20 @@
         {
             "title": "SCIM",
             "url": "https://simplecloud.info/",
+            "children": [
+                {
+                    "title": "RFC7642 - SCIM: Definitions, Overview, Concepts, and Requirements",
+                    "url": "https://tools.ietf.org/html/rfc7642",
+                },
+                {
+                    "title": "RFC7643 - SCIM: Core Schema",
+                    "url": "https://tools.ietf.org/html/rfc7643",
+                },
+                {
+                    "title": "RFC7644 - SCIM: Protocol",
+                    "url": "https://tools.ietf.org/html/rfc7644",
+                },
+            ],
         },
         {"title": "PyPI", "url": "https://pypi.org/project/scim_cli"},
     ],

doc/index.rst

@@ -1,11 +1,12 @@
-scim-cli
-========
-
-scim-cli is a tool to help you develop scim applications.
+.. include:: ../README.md
+   :parser: myst_parser.parsers.docutils_
 
 .. danger ::
 
-   scim-cli is in very early development, there is nothing to use yet!
+    scim-cli is in very early development, there is not much to use yet!
+
+Table of contents
+-----------------
 
 .. toctree::
     :maxdepth: 2

poetry.lock

@@ -42,6 +42,7 @@ pytest-httpserver = "^1.0.10"
 shibuya = "^2024.5.15"
 sphinx = "^7.3.7"
 sphinx-click = "^6.0.0"
+myst-parser = "^3.0.1"
 
 [tool.poetry.scripts]
 scim = "scim_cli:cli"