From 78c28d6f9ee87212b7c0b43f2bc4659d2cea7034 Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Wed, 31 Mar 2021 21:41:05 +0200 Subject: [PATCH] Add more doc --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c4994af..de4739e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ # Hodler -holder is a lightweight interactive terminal based UI application for monitoring your cryptocurrency portfolio in real-time. + +![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. ## Features / Roadmap @@ -14,6 +19,31 @@ holder is a lightweight interactive terminal based UI application for monitoring * :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.