diff --git a/README.md b/README.md index 25debd9..5e1e17e 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,32 @@ A simple cross-platform crypto monitor that monitors the price of crypto currencies. +![Crypto Monitor](./imgs/crypto-monitor.png) + *This project is under development.* + +## Features + +- Cross-platform: Windows, macOS, Linux +- Real-time crypto price monitoring +- Obtain crypto price data from OKX(currently!) + +## Usage + +1. Download the latest release from the [Releases](https://github.com/shiquda/crypto-monitor/releases) page. +2. There are four buttons on the top: + - `+`: Edit the crypto currency to monitor + - `-`: Minimize the window + - `📍`: Keep the window on top + - `❌`: Close the window +3. Double click the crypto currency item to open the *okx* page of the crypto currency in your default browser. + +## TODO + +- [ ] Settings page +- [ ] More price data sources, e.g. Binance + +## Credits + +- [wails](https://wails.io/) +- [go-okx](https://github.com/iaping/go-okx) diff --git a/imgs/crypto-monitor.png b/imgs/crypto-monitor.png new file mode 100644 index 0000000..679a13f Binary files /dev/null and b/imgs/crypto-monitor.png differ