From a3cf49f4c54f450658ea340c550c4a79b571b730 Mon Sep 17 00:00:00 2001
From: Victor Hu <whowutwut@gmail.com>
Date: Thu, 11 Apr 2019 15:30:25 -0400
Subject: [PATCH] Replace the README.rst with a Markdown file, add badges for
 documentation status

---
 README.md  | 25 +++++++++++++++++++++++++
 README.rst | 26 --------------------------
 2 files changed, 25 insertions(+), 26 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..099daf883
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# xCAT
+
+xCAT is a toolkit for deployment and administration of clusters of all sizes.
+
+# Documentation 
+
+xCAT Documentation is hosted on Read The Docs: https://xcat-docs.readthedocs.io
+
+## Status
+
+| xCAT Version | Build Status | 
+|---|---|
+| Latest (master branch) | [![Documentation Status](https://readthedocs.org/projects/xcat-docs/badge/?version=latest)](https://xcat-docs.readthedocs.io/en/latest/) |
+| Stable (latest release) | [![Documentation Status](https://readthedocs.org/projects/xcat-docs/badge/?version=stable)](https://xcat-docs.readthedocs.io/en/stable/) |
+
+Looking for [older versions](https://readthedocs.org/projects/xcat-docs/versions/)?
+
+# Open Source License
+
+xCAT is made available under the EPL license: https://opensource.org/licenses/eclipse-1.0.php
+
+# Developers
+
+Want to help? Check out the [developers guide](http://xcat-docs.readthedocs.io/en/latest/developers)!
+
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 36d9cfc0c..000000000
--- a/README.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-xCAT
-----
-
-xCAT is a toolkit for the deployment and administration of clusters.
-
-Documentation
--------------
-
-`The stable documentation of xCAT <https://xcat-docs.readthedocs.io/en/stable/>`_
-
-`The latest documentation of xCAT <http://xcat-docs.readthedocs.io/en/latest/index.html>`_
-
-`The documentation of xCAT each release <http://readthedocs.org/projects/xcat-docs/versions/>`_
-
-
-Open Source License
--------------------
-
-xCAT is made available as open source software under the EPL license:
-http://www.opensource.org/licenses/eclipse-1.0.php
-
-Developers
-----------
-
-Developers and prospective contributors are encouraged to read the `Developers Guide <http://xcat-docs.readthedocs.io/en/latest/developers/>`_
-In particular the `GitHub <http://xcat-docs.readthedocs.io/en/latest/developers/github/>`_ related subsection.