From 332b4f74b6a2a5a149c6146d70adcc363f7feef7 Mon Sep 17 00:00:00 2001
From: Clemens Wolff <clewolff@microsoft.com>
Date: Sun, 12 Aug 2018 15:56:13 -0400
Subject: [PATCH] Convert readme to restructured text

---
 README.md  |  5 -----
 README.rst | 35 +++++++++++++++++++++++++++++++++++
 setup.py   |  2 +-
 3 files changed, 36 insertions(+), 6 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index c55d831..0000000
--- a/README.md
+++ /dev/null
@@ -1,5 +0,0 @@
-[![Travis CI status](https://api.travis-ci.org/ascoderu/mkwvconf.svg?branch=master)](https://travis-ci.org/ascoderu/mkwvconf)
-
-This is a fork of mkwvconf modified to work on Python 2.7 and later
-
-The original mkwvconf lives here: https://github.com/schuay/mkwvconf
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..8ff72a0
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,35 @@
+mkwvconf
+========
+
+.. image:: https://api.travis-ci.org/ascoderu/mkwvconf.svg?branch=master
+    :target: https://travis-ci.org/ascoderu/mkwvconf
+
+.. image:: https://img.shields.io/pypi/v/mkwvconf.svg
+    :target: https://pypi.org/project/mkwvconf/
+
+Overview
+--------
+
+The :code:`mkwvconf.py` program is a tool that automatically generates a
+`wvdial <https://linux.die.net/man/1/wvdial>`_ configuration for mobile
+broadband devices using the `mobile-broadband-provider-info <https://github.com/GNOME/mobile-broadband-provider-info>`_ package.
+
+This repo is a fork of mkwvconf modified to work on Python 2.7 and later. The
+original mkwvconf can be found at `schuay/mkwvconf <https://github.com/schuay/mkwvconf>`_.
+
+Usage
+-----
+
+First, install the tool and its system dependency:
+
+.. sourcecode :: bash
+
+    python3 -m pip install mkwvconf
+    apt-get install mobile-broadband-provider-info
+
+After installation, you can run tool to guide you through an interactive
+setup experience that generates a wvdial configuration file for you:
+
+.. sourcecode :: bash
+
+    mkwvconf.py
diff --git a/setup.py b/setup.py
index 7c8ad82..5fedc63 100644
--- a/setup.py
+++ b/setup.py
@@ -4,7 +4,7 @@
 with open('version.txt') as fobj:
     version = fobj.read().strip()
 
-with open('README.md') as fobj:
+with open('README.rst') as fobj:
     long_description = fobj.read().strip()