From b69a8c4e4dd317f83c125710a908bceeab570f4c Mon Sep 17 00:00:00 2001
From: Mathias Brulatout <m.brulatout@criteo.com>
Date: Fri, 15 Mar 2024 13:34:04 +0100
Subject: [PATCH] docs: add readme badges with pypi version, python version,
 and maintained status

---
 .github/workflows/main.yml |  2 +-
 README.rst => README.md    | 16 +++++++---------
 setup.py                   |  2 +-
 3 files changed, 9 insertions(+), 11 deletions(-)
 rename README.rst => README.md (73%)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 7eee89d..c86730d 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -6,7 +6,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
-      max-parallel: 4
+      max-parallel: 5
       matrix:
         python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
diff --git a/README.rst b/README.md
similarity index 73%
rename from README.rst
rename to README.md
index 85063c2..4178630 100644
--- a/README.rst
+++ b/README.md
@@ -1,5 +1,4 @@
-Python client for `Consul.io <http://www.consul.io/>`_
-======================================================
+# py-consul [![PyPi version](https://img.shields.io/pypi/v/py-consul.svg)](https://pypi.python.org/pypi/py-consul/) [![Python version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/) ![Status](https://img.shields.io/badge/status-maintained-green.svg)
 
 Fork intent
 -----------
@@ -13,8 +12,7 @@ on pypi; see https://pypi.org/project/py-consul/
 Example
 -------
 
-.. code:: python
-
+```python
     import consul
 
     c = consul.Consul()
@@ -27,13 +25,13 @@ Example
 
     # in another process
     c.kv.put('foo', 'bar')
+```
 
 Installation
 ------------
-
-::
-
+```bash
     pip install py-consul
+```
 
 **Note:** When using py-consul library in environment with proxy server, setting of ``http_proxy``, ``https_proxy`` and ``no_proxy`` environment variables can be required for proper functionality.
 
@@ -47,5 +45,5 @@ open a PR or Issue we'll try and respond as quickly as we're able.
 
 When you create a PR please ensure:
 
-#. To add tests for your new features, if reasonable
-#. To add docstrings for new api features you may add
+- To add tests for your new features, if reasonable
+- To add docstrings for new api features you may add
diff --git a/setup.py b/setup.py
index b1ba288..55964fc 100644
--- a/setup.py
+++ b/setup.py
@@ -42,7 +42,7 @@ def run_tests(self):
         sys.exit(errno)
 
 
-with open("README.rst", encoding="utf-8") as f1, open("CHANGELOG.rst", encoding="utf-8") as f2:
+with open("README.md", encoding="utf-8") as f1, open("CHANGELOG.rst", encoding="utf-8") as f2:
     long_description = f"{f1.read()}\n\n{f2.read()}"
 
 setup(