From e797271ee21b943afc42c02fff2fc51199e31055 Mon Sep 17 00:00:00 2001
From: corei8 <corei8.github@gmail.com>
Date: Wed, 23 Mar 2022 06:13:35 -0400
Subject: [PATCH] Update and rename README to README.md

---
 README    | 24 ------------------------
 README.md | 29 +++++++++++++++++++++++++++++
 2 files changed, 29 insertions(+), 24 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 31235cb..0000000
--- a/README
+++ /dev/null
@@ -1,24 +0,0 @@
-Flask-Markdown
-
-This is a small module to load markdown processing into
-your flask.
-
-To setup the development environment
-
-  $ git clone https://github.com/dcolish/flask-markdown.git
-  $ virtualenv ENV
-  $ . ENV/bin/activate
-  $ python setup.py develop
-
-You should now be able to run the test suite with
-
-  $ python setup.py test
-
-!! There is a bug in the current release of 'nose' which results in 'NoneType'
-   objects being called on test-suite shutdown. Please ignore this.
-
-To setup the documentation environment
-
-  $ pip install sphinx
-  $ git submodule init
-  $ git submodule update
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..38f8c6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Flask-Markdown
+
+This is a small module to load markdown processing into
+your flask.
+
+## To setup the development environment
+
+```bash
+$ git clone https://github.com/dcolish/flask-markdown.git
+$ virtualenv ENV
+$ . ENV/bin/activate
+$ python setup.py develop
+```
+
+## Run the test site
+
+```bash
+$ python setup.py test
+```
+
+#### !! There is a bug in the current release of 'nose' which results in 'NoneType' objects being called on test-suite shutdown. Please ignore this.
+
+## To setup the documentation environment
+
+```bash
+$ pip install sphinx
+$ git submodule init
+$ git submodule update
+```