shellfolio/README.md

# shellfolio

shellfolio is a cryptocurrency portfolio manager and price tracker for the CLI. It gathers it's information from coinmarketcap.com, calculates what your coins are worth, what your gains and losses are and presents the results on the shell:

![screenshot](/screenshot_cli.png?raw=true "screenshot")

# Installation

* Copy the file _.shellfolio_ into your home directory
* Copy the file _shellfolio.sh_ into a directory that is in you PATH variable
* Set the correct file permissions: _chmod u+x shellfolio.sh_


# Configuration

Edit the file _~/.shellfolio_ like this:

```
COINS="ethereum ripple stellar iota cardano digibyte neo nem dogecoin bitcoin-cash"
ETH=4.3:0
XRP=234:0
XLM=3984:0
MIOTA=389:0
ADA=821:0
DGB=9821:0
NEO=10.3:0
XEM=821:0
DOGE=987324:0
BCH=20:0
```

The variable $COINS defines all coins you want to be listed, must be referenced by their name. All other variables are coins you own (must be the ticker name), their value represents the amount you have. Insert how much you invested (in USD)
after ":" in order to see your gains and losses.

In summary the variable definiton for each coin is:

$SYMBOL=amount:investment
Initial commit 2018-01-23 13:20:22 +00:00			`# shellfolio`
Update README.md 2018-01-23 13:35:30 +00:00
Update README.md 2018-01-28 18:24:53 +00:00			`shellfolio is a cryptocurrency portfolio manager and price tracker for the CLI. It gathers it's information from coinmarketcap.com, calculates what your coins are worth, what your gains and losses are and presents the results on the shell:`
Update README.md 2018-01-23 13:35:30 +00:00
Update README.md 2018-01-23 16:22:40 +00:00			`![screenshot](/screenshot_cli.png?raw=true "screenshot")`
Update README.md 2018-01-23 15:13:30 +00:00
Update README.md 2018-01-23 13:35:30 +00:00			`# Installation`

			`* Copy the file _.shellfolio_ into your home directory`
			`* Copy the file _shellfolio.sh_ into a directory that is in you PATH variable`
			`* Set the correct file permissions: _chmod u+x shellfolio.sh_`


			`# Configuration`

Update README.md 2018-01-23 13:35:53 +00:00			`Edit the file _~/.shellfolio_ like this:`
Update README.md 2018-01-23 13:35:30 +00:00
			```
Update README.md 2018-01-28 18:25:47 +00:00			`COINS="ethereum ripple stellar iota cardano digibyte neo nem dogecoin bitcoin-cash"`
Update README.md 2018-01-28 18:24:53 +00:00			`ETH=4.3:0`
			`XRP=234:0`
			`XLM=3984:0`
			`MIOTA=389:0`
			`ADA=821:0`
			`DGB=9821:0`
			`NEO=10.3:0`
			`XEM=821:0`
			`DOGE=987324:0`
Update README.md 2018-01-28 18:25:47 +00:00			`BCH=20:0`
Update README.md 2018-01-23 13:35:30 +00:00			```

Update README.md 2018-01-28 18:24:53 +00:00			`The variable $COINS defines all coins you want to be listed, must be referenced by their name. All other variables are coins you own (must be the ticker name), their value represents the amount you have. Insert how much you invested (in USD)`
			`after ":" in order to see your gains and losses.`
Update README.md 2018-01-28 18:26:45 +00:00
			`In summary the variable definiton for each coin is:`

			`$SYMBOL=amount:investment`