Skip to content

Commit 01793a2

Browse files
committed
docs: install instructions
1 parent 907290e commit 01793a2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,21 @@
44

55
This is a simple event provider for [Sketchybar](https://github.com/FelixKratz/SketchyBar?tab=readme-ov-file) that sends system stats to Sketchybar via the event trigger `system_stats`.
66

7-
## Build instructions
7+
## Installation
88

9-
At this time it is necessary to compile and install the crate locally. The simplest way to do this is to [install the Rust toolchain](https://rustup.rs/).
9+
### Prebuilt binaries
10+
11+
You can download a prebuilt binary for Apple Silicon (aarch64) and Intel Macs (x86_64) from the [latest release](https://github.com/joncrangle/sketchybar-system-stats/releases).
12+
13+
### Build locally
14+
15+
1. [Install the Rust toolchain](https://rustup.rs/).
1016

1117
```bash
1218
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
1319
```
1420

15-
Then use `cargo` to build the binary:
21+
2. Use `cargo` to build the binary:
1622

1723
```bash
1824
git clone https://github.com/joncrangle/sketchybar-system-stats.git

0 commit comments

Comments
 (0)