README.md in capwatch-0.1.13 vs README.md in capwatch-0.2.0
- old
+ new
@@ -9,58 +9,33 @@
## Installation
$ gem install capwatch
-
-```bash
-cat <<EOT > ~/.capwatch
-{
- "name": "Basic Fund",
- "symbols": {
- "MAID": 25452.47,
- "GAME": 22253.51,
- "NEO": 3826.53,
- "FCT": 525.67875,
- "SC": 4152770,
- "DCR": 453.22,
- "BTC": 8.219,
- "ETH": 166.198,
- "KMD": 19056.20,
- "LSK": 5071.42
- }
-}
-EOT
-```
-
$ capwatch
+Don't forget to edit `~/.capwatch` with the amount of cryptocurrencies that you hold.
## Telegram
-If you want to get portfolio notifications on demand to your telegram, you'll need:
+If you want to get portfolio notifications on demand into your telegram, you'll need:
1. Create a telegram bot via [BotFather](https://core.telegram.org/bots)
2. Get the bot `token`
3. Start capwatch with the bot `token` in hand
-
$capwatch -e <bot_token>
Currently Capwatch supports only two commands
- `/watch` - shows the entire portfolio
- `/cap` - shows only the footer of the portfolio, e.g. summaries
Remember to start it on a server in a tmux window or as a daemon.
-## Fund Examples
+## Data Providers
-Fund examples can be found [here](funds/demo)
+- http://coinmarketcap.com
-Demo funds taken from www.bluemagic.info
+## Demo Funds
-Data is being processed from from http://coinmarketcap.com
-
-## Todo
-- [ ] Write Tests
-- [ ] Re-factor the table class
+Fund examples can be found [here](spec/fixtures/funds) which were taken from [here](www.bluemagic.info)