hodler/README.md

# Hodler

<!-- ![Build](https://github.com/glenux/hodler/workflows/build/badge.svg?branch=master) -->

[![GitHub license](https://img.shields.io/github/license/glenux/hodler.svg)](https://github.com/glenux/hodler/blob/master/LICENSE.txt)
[![Donate on patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://patreon.com/glenux)

Holder is a lightweight interactive terminal based UI application for monitoring your cryptocurrency portfolio in real-time.

**For now It is a toy project. It is very early stage and is not supposed to work (yet). Please don't use it in production.** :warning:

## Features / Roadmap

* :x: Multiple wallets description
* :x: Trade history support (buy date, buy price, now price, amount)
* :x: Invest + current wealth + win/loss + percent calculation
* :x: Report-mode output
* :x: Ncurses output (first read-only, then interactive)
* :x: Wallet import (CEX plugins)
* :x: Trade history import (CEX plugins)
* :x: Real time update

## Installation

:wip: FIXME

## Usage

:wip: FIXME


## Contributing

1. Fork it ( http://github.com/glenux/hodler/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request


## Credits

* [Glenn Y. ROLLAND](https://github.com/glenux) - author & maintainer:
* You? Fork the project and become a contributor!

Got questions? Need help? Tweet at [@glenux](https://twitter.com/glenux)

## Inspirations

* [cryptop](https://github.com/huwwp/cryptop): Nice ncurses UI. Not support for wallet naming, nor trade history.
* [cointop](https://github.com/miguelmota/cointop): Nice ncurses UI & good shortcut keys + README file. Not support for wallet/portfolio.
* [coinwatch](https://github.com/cytopia/coinwatch): Good support for trade history. 100% configuration based. Not support for CEX trade import nor interactive UI.
* [foxfolio](): Nice GUI & options. Heavy browser-based app, not running in terminal. Still unstable. 

## Tip Jar

[![BTC Tip Jar](https://img.shields.io/badge/BTC-tip-yellow.svg?logo=bitcoin&style=flat)]() `xxx`

[![ETH Tip Jar](https://img.shields.io/badge/ETH-tip-blue.svg?logo=ethereum&style=flat)]() `xxx`

[![Donate on patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://patreon.com/glenux)

Thank you for tips! :pray:

## License

Released under the GNU LGPL-3 license.