From 6b1569a62b1decb9d99db7e08f2e3793d6204d1e Mon Sep 17 00:00:00 2001
From: Daniel Schep <dschep@gmail.com>
Date: Mon, 4 Jan 2016 17:51:28 -0500
Subject: [PATCH] Switch to reStructuredText for README (better for PyPi!)

---
 MANIFEST.in |  2 +-
 README.md   | 59 --------------------------------------
 README.rst  | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.cfg   |  2 +-
 setup.py    |  8 +-----
 5 files changed, 84 insertions(+), 68 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/MANIFEST.in b/MANIFEST.in
index 3760f73..fa3ae80 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,3 @@
 include MANIFEST.in
-include README.md
+include README.rst
 include LICENSE
diff --git a/README.md b/README.md
deleted file mode 100644
index 282ea3d..0000000
--- a/README.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# About `ntfy`
-
-`ntfy` is a command line utility (and to a degree, python library) for sending
-push notifications. It also can send a notification when a program finishes.
-
-Unlike many existing utilities for Pushover or Pushbullet,
-it supports multiple backends.
-
-## Demo
-[Click for full demo![Click for full demo](demo/ntfy-demo.gif)](https://cdn.rawgit.com/dschep/ntfy/master/demo/ntfy-demo.mp4)
-
-## Install
-```
-sudo pip install ntfy
-```
-
-Note: It is suggested to globally (as indicated above, without a virtualenv) install ntfy. It _can_ be installed in a virtualenv, but Mac OS X & Windows notifications won't work.
-
-## Usage
-```
-
-# send a notification
-ntfy send "Here's a notification!"
-
-# send a notification with custom title (default is $USER@$HOST)
-ntfy send -t 'ntfy' "Here's a notification with a custom title!"
-
-# send a notification when the command `sleep 10` finishes
-# this send the message '"sleep 10" succeeded in 0.2 minutes'
-ntfy done sleep 10
-```
-
-
-# Backends
- - [x] [Pushover](https://pushover.net)
- - [x] [Pushbullet](https://pushbullet.com)
- - [x] Linux Desktop Notifications (notify-send)
- - [X] Windows Desktop Notifications (requires [PyWin32](http://sourceforge.net/projects/pywin32/))
- - [x] Mac OS X Notification Center
- - [ ] [Prowl](http://www.prowlapp.com)
- - [ ] [Airgram](http://www.airgramapp.com)
- - [ ] [Pushjet](https://pushjet.io)
- - [ ] [Pushalot](https://pushalot.com)
- - [ ] [Boxcar](https://boxcar.io)
- - [ ] [Instapush](https://instapush.im)
-
-## Config
-`ntfy` is configured via a json config file stored at `~/.ntfy.json`. It
-requires at minimum 2 keys: backend & a config for that backend.
-
-For full docs consult the [wiki](https://github.com/dschep/ntfy/wiki)
-
-### Example Config
-```
-{
-    "backend": "pushbullet",
-    {"pushbullet": {"access_token": "<redacted>"}}
-}
-```
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..6e64a03
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,81 @@
+About ``ntfy``
+==============
+
+``ntfy`` is a command line utility (and to a degree, python library) for
+sending push notifications. It also can send a notification when a
+program finishes.
+
+Unlike many existing utilities for Pushover or Pushbullet, it supports
+multiple backends.
+
+Demo
+----
+`Click here for full demo <https://cdn.rawgit.com/dschep/ntfy/master/demo/ntfy-demo.mp4>`_
+
+.. image:: https://raw.githubusercontent.com/dschep/ntfy/master/demo/ntfy-demo.gif
+
+Install
+-------
+
+::
+
+    sudo pip install ntfy
+
+Note: It is suggested to globally (as indicated above, without a
+virtualenv) install ntfy. It *can* be installed in a virtualenv, but Mac
+OS X & Windows notifications won't work.
+
+Usage
+-----
+
+::
+
+
+    # send a notification
+    ntfy send "Here's a notification!"
+
+    # send a notification with custom title (default is $USER@$HOST)
+    ntfy send -t 'ntfy' "Here's a notification with a custom title!"
+
+    # send a notification when the command `sleep 10` finishes
+    # this send the message '"sleep 10" succeeded in 0.2 minutes'
+    ntfy done sleep 10
+
+Backends
+========
+
+Supported
+---------
+-  `Pushover <https://pushover.net>`_
+-  `Pushbullet <https://pushbullet.com>`_
+-  Linux Desktop Notifications (notify-send)
+-  Windows Desktop Notifications (requires `PyWin32 <http://sourceforge.net/projects/pywin32/>`_)
+-  Mac OS X Notification Center
+
+ToDo
+----
+-  `Prowl <http://www.prowlapp.com>`_
+-  `Airgram <http://www.airgramapp.com>`_
+-  `Pushjet <https://pushjet.io>`_
+-  `Pushalot <https://pushalot.com>`_
+-  `Boxcar <https://boxcar.io>`_
+-  `Instapush <https://instapush.im>`_
+
+Config
+------
+
+``ntfy`` is configured via a json config file stored at
+``~/.ntfy.json``. It requires at minimum 2 keys: backend & a config for
+that backend.
+
+For full docs consult the `wiki <https://github.com/dschep/ntfy/wiki>`_
+
+Example Config
+~~~~~~~~~~~~~~
+
+::
+
+    {
+        "backend": "pushbullet",
+        {"pushbullet": {"access_token": "<redacted>"}}
+    }
diff --git a/setup.cfg b/setup.cfg
index b88034e..5aef279 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description-file = README.rst
diff --git a/setup.py b/setup.py
index 5248e62..1144aaa 100644
--- a/setup.py
+++ b/setup.py
@@ -1,20 +1,14 @@
 from setuptools import setup
-from codecs import open  # To use a consistent encoding
 from os import path
 
 here = path.abspath(path.dirname(__file__))
 
-# Get the long description from the relevant file
-with open(path.join(here, 'README.md'), encoding='utf-8') as f:
-    long_description = f.read()
-
 setup(
     name='ntfy',
 
-    version='0.1.4',
+    version='0.1.5',
 
     description='A utility for sending push notifications',
-    long_description=long_description,
 
     url='https://github.com/dschep/ntfy',