Use RST README

kz26 · Aug 22, 2016 · ad9ebbc · ad9ebbc
1 parent ef33628
commit ad9ebbc
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 4 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,26 @@
+dottorrent
+==========
+
+High-level Python 3 library and CLI tool for creating .torrent files
+
+Documentation
+-------------
+
+Full documentation on how to use the dottorrent as a Python library and
+from the command line is available at [dottorrent.readthedocs.io](http://dottorrent.readthedocs.io/).
+
+.. image:: https://readthedocs.org/projects/dottorrent/badge/
+
+
+Installation
+------------
+
+Stable releases are available on PyPI and can be installed using ``pip``.
+::
+
+	pip install dottorrent
+
+License
+-------
+
+[MIT](https://opensource.org/licenses/MIT)
diff --git a/setup.py b/setup.py
@@ -16,8 +16,8 @@
     # metadata for upload to PyPI
     author="Kevin Zhang",
     author_email="kevin@kevinzhang.me",
-    description="This is an Example Package",
-    license="MIT",
+    description="High-level Python 3 library and CLI tool for creating .torrent files",
+    long_description=open('README.rst').read(),
     keywords="bittorrent torrent bencode",
     url="https://github.com/kz26/dottorrent",   # project home page, if any