Switch to README.md

vexxhost · Jul 24, 2024 · 4010309 · 4010309
1 parent 7f35f89
commit 4010309
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 24 deletions.
diff --git a/README.md 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
diff --git 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