diff --git a/README.md b/README.md index 63907b2..fc5fb83 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,24 @@ You can find the latest releases in the [Releases section](https://git.marcodear ## Installation ### Option 1: Download built Binary (Recommended) + 1. Go to the [Releases page](https://git.marcodearaujo.com/marcodearaujo/uptime-kuma-dashboard/releases) -2. Download the binary for your operating system -3. Make it executable: `chmod +x uptime-kuma-dashboard` -4. Run it with your Uptime Kuma URL and slug +2. Download the binary for your operating system: + - **Linux (x86_64)**: `uptime-kuma-dashboard-x86_64-unknown-linux-gnu` + - **Linux (ARM64)**: `uptime-kuma-dashboard-aarch64-unknown-linux-gnu` (Raspberry Pi, ARM servers) + - **Windows**: `uptime-kuma-dashboard-x86_64-pc-windows-gnu.exe` +3. Verify the checksum (recommended for security): + ```bash + sha256sum -c SHA256SUMS.txt + ``` +4. Make it executable (Linux/ARM only): + ```bash + chmod +x uptime-kuma-dashboard-* + ``` +5. Run with your parameters: + ```bash + ./uptime-kuma-dashboard-* --base-url="http://your-kuma:3001/" --slug="your-slug" + ``` ### Option 2: Build From Source @@ -77,11 +91,13 @@ The dashboard requires two parameters: - `--slug`: Your status page slug identifier Example: + ```bash ./uptime-kuma-dashboard --base-url="http://192.168.1.100:3001/" --slug="home-services" ``` **Controls during runtime:** + - `q` or `ESC`: Exit the dashboard - `↑`/`↓` or `k`/`j`: Navigate through monitors - `Home`/`End`: Jump to top/bottom of the list @@ -98,6 +114,7 @@ export STATUS_PAGE_SLUG="your-status-page-slug" ## Development Notes This project follows Rust best practices including: + - Comprehensive error handling with `anyhow` - Internationalization-ready architecture - Modular code organization @@ -105,28 +122,17 @@ This project follows Rust best practices including: - Cross-platform compatibility testing The architecture separates concerns into: + - API client layer - Data processing core - UI rendering components - Configuration management - Internationalization system -## Contribution - -While this is primarily a personal project, I welcome suggestions and improvements! If you have ideas for new features or bug fixes: - -1. Fork the repository -2. Create a feature branch (`git checkout -b feature/amazing-feature`) -3. Commit your changes (`git commit -m 'Add some amazing feature'`) -4. Push to the branch (`git push origin feature/amazing-feature`) -5. Open a pull request - -Please note this is a side project, so response times may vary. - ## License This project is available under the MIT License - see the [LICENSE](LICENSE) file for details. --- -*Developed as a personal learning project to improve Rust skills and create a useful tool for my home lab monitoring. Feedback welcome!* +_Developed as a personal learning project to improve Rust skills and create a useful tool for my home lab monitoring. Feedback welcome!_