<NME> README.rst
<BEF> cryptop
=======
cryptop is a lightweight command line based cryptocurrency portfolio.
Built on Python 3 and ncurses with simplicity in mind, cryptop updates in realtime.

.. image:: img\cryptop.png

Installation
------------

cryptop requires Python 3 to run, and has only been tested in Python 3.6 so far.

The easiest way to install cryptop is through pip

.. code:: bash

    sudo pip install cryptop
    
You may need to force pip3 depending on your python install

    sudo python setup.py install

setup.py can be run with a --user flag if you would prefer
not to sudo.

Usage
.. code:: bash

    sudo python setup.py install

pip and setup.py can be run with a --user flag if you would prefer not to sudo. Both require setuptools which is included in most python installs and many distros by default

Usage
-----

Start from a terminal.

.. code:: bash

    cryptop

Follow the on screen instructions to add/remove cryptocurrencies from your portfolio.

Customisation
-------------

Cryptop creates two config files in a .cryptop folder in your home directory.

.crypto/config.ini contains theme configuration (text/background colors) and
options to change the output currency (default USD), update frequency, number of decimal places to display and maximum width for float values.

.. image:: img\fall.png

.. image:: img\aesth.png

.cryptop/wallet.json contains the coins and amounts you hold, you shouldn't need to edit it manually

Credits
-------

Uses the `cryptocompare.com API
<http://www.cryptocompare.com/>`_.

Tipjar
------

BTC: 15wNW29q7XAEbC8yus49CWvt91JkhcdkoW

Disclaimer
----------

I am not liable for the accuracy of this program’s output nor actions
performed based upon it.

<MSG> Update README.rst
<DFF> @@ -20,7 +20,7 @@ cryptop can be installed manually, download the repo and run
 
     sudo python setup.py install
 
-setup.py can be run with a --user flag if you would prefer
+pip and setup.py can be run with a --user flag if you would prefer
 not to sudo.
 
 Usage

Update README.rst