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

.. image:: cryptop.png

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

Installed manually, download the repo and run (pip coming soon)

.. code:: bash

.. code:: bash

    sudo pip3 install cryptop

cryptop can be installed manually, download the repo and run

.. 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

    cryptop

Cryptop creates two config dotfiles in your home directory.

.cryptop contains the holdings for the porftolio.

.cryptopc contains light configuration/ricing options for colors and backgrounds.


Credits
-------
.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> Updated readme, cleaning

<DFF> @@ -3,12 +3,18 @@ cryptop
 cryptop is a lightweight command line based cryptocurrency portfolio.
 Built on python and ncurses with simplicity in mind.
 
-.. image:: cryptop.png
+.. image:: img\cryptop.png
 
 Installation
 ------------
 
-Installed manually, download the repo and run (pip coming soon)
+The easiest way to install cryptop is through pip
+
+.. code:: bash
+
+    sudo pip install cryptop
+
+cryptop can be installed manually, download the repo and run
 
 .. code:: bash
 
@@ -26,12 +32,17 @@ Start from a terminal.
 
     cryptop
 
-Cryptop creates two config dotfiles in your home directory.
+Customisation
+-------------
 
-.cryptop contains the holdings for the porftolio.
+Cryptop creates two config dotfiles in your home directory. .cryptop contains 
+the holdings data for the porftolio.
 
 .cryptopc contains light configuration/ricing options for colors and backgrounds.
 
+.. image:: img\fall.png
+
+.. image:: img\aesth.png
 
 Credits
 -------

Updated readme, cleaning