From f38b046b546f148182b14fd722a9a1d0c125a59a Mon Sep 17 00:00:00 2001 From: xzeldon Date: Wed, 11 Dec 2024 04:39:19 +0300 Subject: [PATCH] docs: add installation instructions --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 51310a5..46f3dc0 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,11 @@ Show your wireless Razer devices battery levels in your system tray. ## Usage -### Downloading a Prebuilt Binary +### Installation -> _Todo_ +1. Download `razer-battery-report.exe` from [latest release](https://github.com/xzeldon/razer-battery-report/releases/latest) +2. Run `razer-battery-report.exe` +3. If you want a start menu shortcut you can make one yourself! Simply right-click `razer-battery-report.exe` and select "Pin to Start". This will automatically create a shortcut in %appdata%\Microsoft\Windows\Start Menu\Programs. ### Building from Source @@ -44,7 +46,7 @@ To build, you must have [Rust](https://www.rust-lang.org/) and - [ ] Colored tray icons for different battery levels - [x] Show log window button in tray menu - [x] Further reduce CPU usage by using Event Loop Proxy events (more info [here](https://github.com/tauri-apps/tray-icon/issues/83#issuecomment-1697773065)) -- [ ] Prebuilt Binary +- [x] Prebuilt Binary - [ ] Command Line Arguments for update frequency - [ ] Support for other Razer Devices (I only have DeathAdder V3 Pro, so I won't be able to test it with other devices)