Update README.md

This commit is contained in:
Gerald-H 2025-03-19 06:03:44 +01:00 committed by GitHub
parent 81d098b7aa
commit 13d9899688
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -2,7 +2,7 @@
A lightweight Docker-based web tool to monitor cryptocurrency prices (via Binance and OKX) with **unlimited alarms** and **unlimited crypto tracking**, outshining typical TradingView limitations. It also provides quick access to multiple RSS-based crypto news sources and a live Economic Calendar.
<img src="https://github.com/user-attachments/assets/15c9227b-0683-4563-8b71-75f2f9ed475e" width="800" height="auto">
<img src="https://github.com/user-attachments/assets/d87ca663-97be-4c22-a0ab-46505fe9c99f" width="800" height="auto">
## Demo
@ -11,6 +11,8 @@ Check out the live demo here: [HodlEye Demo](https://hodleye.gerald-hasani.com/)
**Default Login Data**
**User:** admin
**Password:** admin
---
@ -47,7 +49,7 @@ Check out the live demo here: [HodlEye Demo](https://hodleye.gerald-hasani.com/)
- **Unlimited Crypto Tracking**: Easily add as many coins as you want.
- **Real-Time Price Updates (every 1 seconds)**: Uses Binance and OKX data.
- **Crypto News & Economic Calendar**: Stay updated on the latest events affecting the market.
- **TradingView Modal Integration**: Click on any crypto pair to open a TradingView modal for in-depth chart analysis.
- **TradingView Modal Integration**: Click on any crypto pair to open a TradingView modal for in-depth chart analysis.**New**
The tool refreshes prices every **1 seconds**, which may introduce a slight delay in alarm triggers if the price quickly touches the threshold in between intervals.
@ -122,6 +124,8 @@ The tool refreshes prices every **1 seconds**, which may introduce a slight dela
- (Optional) [Docker-Compose](https://docs.docker.com/compose/) if you want a more complex or multi-container setup.
&nbsp;
---
### Environment Variables (.env)
You can store the username, password, and a secret key in the `.env` file to protect the application from unauthorized access. **Make sure to change the default credentials to your own secure values**:
@ -138,7 +142,9 @@ SESSION_SECRET=some_secret_key
After building and starting the container, a login prompt will appear when accessing the application, ensuring that only authorized users can proceed.
&nbsp;
---
### Docker Build & Run
1. **Clone this repository**