From 4010309b7c5438d8842f41ece7f0a6c408609ffc Mon Sep 17 00:00:00 2001
From: Mohammed Naser <mnaser@vexxhost.com>
Date: Wed, 24 Jul 2024 15:11:50 -0400
Subject: [PATCH] Switch to README.md

---
 README.md  | 21 +++++++++++++++++++++
 README.rst | 22 ----------------------
 setup.cfg  |  4 ++--
 3 files changed, 23 insertions(+), 24 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..3de2c9ea6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Atmosphere
+
+* Documentation: https://vexxhost.github.io/atmosphere/
+
+## Community
+
+If you have any questions and discussions about Atmosphere, you can join the
+community:
+
+* [#atmosphere](https://kubernetes.slack.com/archives/C056YSPJB7U) channel
+  on the Kubernetes Slack. If you are new to Kubernetes Slack workspace,
+  [Join the Kubernetes Slack workspace](https://slack.kubernetes.io/) first.
+
+## Contributing
+
+You'll need to make sure that you have [pre-commit](https://pre-commit.com)
+setup and installed in your environment by running these commands::
+
+```bash
+pre-commit install --hook-type commit-msg
+```
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 7892e697c..000000000
--- a/README.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-Atmosphere
-==========
-
-* Documentation: https://vexxhost.github.io/atmosphere/
-
-Community
----------
-
-If you have any questions and discussions about Atmosphere, you can join the
-community:
-
-* `#atmosphere <https://kubernetes.slack.com/archives/C056YSPJB7U>`_ channel
-  on the Kubernetes Slack. If you are new to Kubernetes Slack workspace,
-  `Join the Kubernetes Slack workspace <https://slack.kubernetes.io/>`_ first.
-
-Contributing
-------------
-
-You'll need to make sure that you have `pre-commit <https://pre-commit.com>`_
-setup and installed in your environment by running these commands::
-
-    pre-commit install --hook-type commit-msg
diff --git a/setup.cfg b/setup.cfg
index fad6da95e..13429ad7a 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,8 +1,8 @@
 [metadata]
 name = atmosphere
 summary = Simple & easy private cloud platform featuring VMs, Kubernetes & bare-metal
-description_file =
-    README.rst
+description_file = README.md
+description_content_type = text/markdown
 author = VEXXHOST, Inc.
 author_email = support@vexxhost.com
 url = https://github.com/vexxhost/atmosphere