Skip to content

Commit

Permalink
feat: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shiquda committed Dec 1, 2024
1 parent cc33199 commit fe8d550
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Binary file added imgs/crypto-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fe8d550

Please sign in to comment.