version 0.11.4 - update README.rst -> .md

- because .rst does not render properly on pypi and looks sloppy.

README.rst → README.md

@@ -3,39 +3,26 @@ BitSV: Bitcoin SV made easy.
 
 Forked from Ofek's awesome Bit library: https://github.com/ofek/bit
 
-.. image:: https://img.shields.io/pypi/v/bitsv.svg?style=flat-square
-    :target: https://pypi.org/project/bitsv
-
-.. image:: https://img.shields.io/travis/AustEcon/bitsv.svg?branch=master&style=flat-square
-    :target: https://travis-ci.org/AustEcon/bitsv
-
-.. image:: https://img.shields.io/codecov/c/github/AustEcon/bitsv.svg?style=flat-square
-    :target: https://codecov.io/gh/austecon/bitsv
-
-.. image:: https://img.shields.io/pypi/pyversions/bitsv.svg?style=flat-square
-    :target: https://pypi.org/project/bitsv
-
-.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
-    :target: https://en.wikipedia.org/wiki/MIT_License
 
+[![PyPI version](https://img.shields.io/pypi/v/bitsv.svg?style=flat-square)](https://pypi.org/project/bitsv)
+[![build status](https://img.shields.io/travis/AustEcon/bitsv.svg?branch=master&style=flat-square)](https://travis-ci.org/AustEcon/bitsv)
+[![code cov](https://img.shields.io/codecov/c/github/AustEcon/bitsv.svg?style=flat-square)](https://codecov.io/gh/austecon/bitsv)
+[![Python versions](https://img.shields.io/pypi/pyversions/bitsv.svg?style=flat-square)](https://pypi.org/project/bitsv)
+[![Python versions](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://en.wikipedia.org/wiki/MIT_License)
 
 Noticeboard:
 ------------
-Latest Major Release - 0.11.3_ (2020-11-7)
-
-.. _0.11.3: https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst
+Latest Major Release - [0.11.4](https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst) (2021-01-01)
 
 - Added WhatsOnChain API for mainnet and testnet
 - Unspent data type: removed 'script' (scriptpubkey) attribute (unavailable from WhatsOnChain and Satoshi.io APIs and is unused in the codebase).
 - Transaction, TxOutput, TxInput data types: removed unnecessary 'cruft' like 'amount_in', 'amount_out' and 'fee' (also to facilitate use of WhatsOnChain etc. and reduce maintenance overheads).
 - MatterCloud now activated via **'MATTERCLOUD_API_KEY' environment variable** which makes it the highest priority API in the list for main, test, stn. Otherwise WhatsOnChain is used by default.
-- 0.11.1 Fixed an off-by-one bug for generating pushdata op_codes for data-carrier 'op_return' txs - c/o `gitzhou <https://github.com/gitzhou>`_.
+- 0.11.1 Fixed an off-by-one bug for generating pushdata op_codes for data-carrier 'op_return' txs - c/o [gitzhou](https://github.com/gitzhou).
 - 0.11.2 NetworkAPI.broadcast_tx() now returns the txid instead of null.
 - 0.11.3 make 'prepare_transaction' a @classmethod as it should not require a private key (breaking change as function signature now requires the 'network' as a positional argument)
 
-Previous Major Release - 0.10.4_ (2019-02-13)
-
-.. _0.10.4: https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst
+Previous Major Release - [0.10.4](https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst) (2019-02-13)
 
 - Added new Fullnode class for connecting to local bitcoin node via JSON-RPC (thanks goes to https://github.com/xloem for the initial legwork).
 - Fullnode class works for Mainnet, Testnet, Scaling-testnet and RegTest (local mock blockchain).
@@ -44,7 +31,7 @@ Previous Major Release - 0.10.4_ (2019-02-13)
 - Add 'sweep' function to PrivateKey class for sending all coins to a given address.
 - 0.10.1 includes a patch for rpc methods list
 - 0.10.2 includes a patch to fix broken API endpoint for foreign currency conversions.
-- 0.10.3 allow transaction fee less than 1 sat/byte (i.e. float) c/o `gitzhou <https://github.com/gitzhou>`_
+- 0.10.3 allow transaction fee less than 1 sat/byte (i.e. float) c/o [gitzhou](https://github.com/gitzhou)
 - 0.10.4 update main api url from https://api.bitindex.network to https://api.mattercloud.net
 
 
@@ -69,8 +56,7 @@ Examples
 
 1. Simple payment:
 
-.. code-block:: python
-
+```
     >>> import bitsv
     >>> my_key = bitsv.Key('YourPrivateKeyGoesHere')  # Defaults to "main" network
     >>> my_key.get_balance()
@@ -83,31 +69,32 @@ Examples
     >>> ]
     >>> my_key.send(outputs)
     'dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1'
+```
 
-Here's the transaction `<https://whatsonchain.com/tx/dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1>`_.
+Here's the transaction https://whatsonchain.com/tx/dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1.
 
 2. OP_RETURN - 100kb size limit now supported:
 
-.. code-block:: python
-
+```
     >>> import bitsv
     >>> my_key = bitsv.Key('YourPrivateKeyGoesHere')
     >>> list_of_pushdata = ([bytes.fromhex('6d01'),  # encode hex to bytes
                              'New_Name'.encode('utf-8')])  # encode string to utf-8 encoded bytes
     >>> my_key.send_op_return(list_of_pushdata)  # default fee = 1 sat/byte
+```
 
 This sets memo.sv name (linked to this bitcoin address) to "New_Name" (as per https://memo.sv/protocol)
 
 3. Connect to a local 'fullnode' via JSON-RPC:
 
-.. code-block:: python
-
+```
     >>> from bitsv import Fullnode
     >>> fullnode = FullNode(
             conf_dir='/home/username/.bitcoin/regtest.conf',
             rpcuser='user',
             rpcpassword='password',
             network='regtest')
+```
 
 Possible use cases may include:
 
@@ -118,11 +105,9 @@ Possible use cases may include:
 The fullnode object has a complete internal list of all JSON-RPC methods added to __dict__ for code completion and methods return appropriate
 error messages:
 
-.. figure:: images/obj_dict.png
+[![Node autocomplete](images/obj_dict.png)]
 
-For more detailed examples of using the Fullnode class, see README_
-
-.. _README: https://github.com/AustEcon/bitsv/blob/master/bitsv/network/services/README.rst
+For more detailed examples of using the Fullnode class, see [README](https://github.com/AustEcon/bitsv/blob/master/bitsv/network/services/README.rst)
 
 Features
 --------
@@ -141,7 +126,6 @@ Installation
 BitSV is distributed on `PyPI` as a universal wheel and is available on Linux/macOS
 and Windows and supports Python 3.5+ and PyPy3.5-v5.7.1+. ``pip`` >= 8.1.2 is required.
 
-.. code-block:: bash
 
     $ pip install bitsv  # pip3 if pip is Python 2 on your system.
 
@@ -153,19 +137,7 @@ Docs are hosted by Github Pages and are automatically built and published by Tra
 Credits
 -------
 
-- `ofek`_ for the original bit codebase.
-- `teran-mckinney`_ for his work on the bitcash fork
-- `joshua smith`_ for adding BitIndex3
-- `xloem`_ for help with adding Fullnode connectivity
-
-.. _ofek: https://github.com/ofek/bit
-.. _teran-mckinney: https://github.com/sporestack/bitcash
-.. _joshua Smith: https://github.com/joshua-s
-.. _xloem: https://github.com/xloem
-
-Donate
---------
-
-- If you have found this library useful, please consider donating. It really helps.
-- HandCash: $AustEcon
-- 1PdvVPTzXmo4cSs68HctLUxAdW917UZtC8
+- [ofek](https://github.com/ofek/bit)
+- [teran-mckinney](https://github.com/sporestack/bitcash)
+- [joshua Smith](https://github.com/joshua-s)
+- [xloem](https://github.com/xloem)

bitsv/__init__.py

@@ -3,4 +3,4 @@
 from bitsv.network.services import set_service_timeout, FullNode
 from bitsv.wallet import Key, PrivateKey, wif_to_key
 
-__version__ = '0.11.3'
+__version__ = '0.11.4'

setup.py

@@ -10,7 +10,7 @@
     name='bitsv',
     version=version,
     description='Bitcoin SV made easier.',
-    long_description=open('README.rst', 'r').read(),
+    long_description=open('README.md', 'r').read(),
     long_description_content_type='text/markdown',
     author='AustEcon',
     author_email='[email protected]',