Updating READMEs.

Makefile

@@ -42,6 +42,7 @@ docs: coverage
 	mkdir -p docs/source/_static
 	mkdir -p docs/source/_templates
 	cd docs && $(MAKE) html
+	pandoc --from=markdown --to=rst --output=README.rst README.md
 
 answers:
 	cd docs && $(MAKE) html

README.md

@@ -13,11 +13,12 @@ Simple Conveniences for Talking to Elasticsearch
 
 The project's documentation contains a section to help you [get started](http://www.comingsoon.net) as a developer on the project.
 
-## Prerequisites
+## Development Prerequisites
 
-To work with this project you'll need a few things.
+If you're going to be working in the code (rather than just using the library), you'll want a few utilities.
 
 * [GNU Make](https://www.gnu.org/software/make/)
+* [Pandoc](https://pandoc.org/)
 
 ## Resources
 

README.rst

@@ -0,0 +1,81 @@
+elastalk
+========
+
+Simple Conveniences for Talking to Elasticsearch
+
+Project Features
+----------------
+
+-  `elastalk <http://www.comingsoon.net>`__
+-  a `Click <http://click.pocoo.org/5/>`__ command-line application that
+   you can use to generate hashes
+-  automated unit tests you can run with
+   `pytest <https://docs.pytest.org/en/latest/>`__
+-  a `Sphinx <http://www.sphinx-doc.org/en/master/>`__ documentation
+   project
+
+Getting Started
+---------------
+
+The project's documentation contains a section to help you `get
+started <http://www.comingsoon.net>`__ as a developer on the project.
+
+Development Prerequisites
+-------------------------
+
+If you're going to be working in the code (rather than just using the
+library), you'll want a few utilities.
+
+-  `GNU Make <https://www.gnu.org/software/make/>`__
+-  `Pandoc <https://pandoc.org/>`__
+
+Resources
+---------
+
+Below are some handy resource links.
+
+-  `Project Documentation <http://elastalk.readthedocs.io/>`__
+-  `Click <http://click.pocoo.org/5/>`__ is a Python package for
+   creating beautiful command line interfaces in a composable way with
+   as little code as necessary.
+-  `Sphinx <http://www.sphinx-doc.org/en/master/>`__ is a tool that
+   makes it easy to create intelligent and beautiful documentation,
+   written by Geog Brandl and licnsed under the BSD license.
+-  `pytest <https://docs.pytest.org/en/latest/>`__ helps you write
+   better programs.
+-  [GNU Make] is a tool which controls the generation of executables and
+   other non-source files of a program from the program's source files.
+
+Authors
+-------
+
+-  **Pat Daburu** - *Initial work* -
+   `github <https://github.com/patdaburu>`__
+
+See also the list of
+`contributors <https://github.com/patdaburu/elastalk/contributors>`__
+who participated in this project.
+
+LicenseMIT License
+------------------
+
+Copyright (c) patdaburu
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

setup.py

@@ -17,7 +17,7 @@
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the relevant file
-with open(path.join(here, 'README'), encoding='utf-8') as f:
+with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
     long_description = f.read()
 
 # Get the base version from the library.