Adds README.rst for PyPI

snth · Oct 7, 2017 · 09a3b58 · 09a3b58
1 parent 9281439
commit 09a3b58
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,31 @@
+Numismatic - Coin Collecting for Digital Assets
+===============================================
+
+|Join the chat at https://gitter.im/numismatic-chat/Lobby|
+
+Getting started
+---------------
+
+::
+
+    git clone https://github.com/snth/numismatic.git
+    cd numismatic
+    pip install -e .
+
+Run
+---
+
+Run the ``coin`` script from anywhere and explore from there
+
+::
+
+    coin
+
+    coin list
+
+    coin info
+
+    coin listen collect run
+
+.. |Join the chat at https://gitter.im/numismatic-chat/Lobby| image:: https://badges.gitter.im/numismatic-chat/Lobby.svg
+   :target: https://gitter.im/numismatic-chat/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.1.0
+0.1.1
diff --git a/dist/numismatic-0.1.0.tar.gz b/dist/numismatic-0.1.0.tar.gz
diff --git 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
@@ -3,7 +3,7 @@
 from pathlib import Path
 from setuptools import setup
 
-README = Path('README.md').open('rt').read()
+README = Path('README.rst').open('rt').read()
 REQUIREMENTS = Path('requirements.txt').open('rt').read().strip().split('\n')
 print(REQUIREMENTS)
 VERSION = open(Path('VERSION')).read().strip()