diff --git a/README.md b/README.md index 393d59a..c198400 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # hardware-monitor +![GitHub branch status](https://img.shields.io/github/checks-status/shm11C3/hardware-monitor/master) + +![GitHub commits since tagged version](https://img.shields.io/github/commits-since/shm11C3/hardware-monitor/app-v0.1.0) + + + ## Dashboard ![image](https://github.com/user-attachments/assets/9a2bf54f-d6e5-4c20-b0e4-f249fd5b8433) @@ -11,25 +17,35 @@ ## Development -### Require +### Requirements + +- [Node.js 20+](https://nodejs.org/) +- [Rust](https://www.rust-lang.org/) +- [Tauri CLI](https://tauri.app/v1/guides/getting-started/prerequisites) + +### Setup + +1. Clone the repository: -- Node.js 20 -- Rust + ```bash + git clone https://github.com/shm11C3/hardware-monitor.git + cd hardware-monitor + ``` -### Creating a project +2. Install dependencies: -```bash -npm ci -``` + ```bash + npm ci + ``` -### Developing +3. Run the app in development mode: -```bash -npm run tauri dev -``` + ```bash + npm run tauri dev + ``` -### Building +4. Build the app for production: -```bash -npm run tauri build -``` + ```bash + npm run tauri build + ```