Skip to content
This repository was archived by the owner on Oct 1, 2025. It is now read-only.

Commit 1002eef

Browse files
committed
docs: add github release instructions and CI badges to README
1 parent 4082bda commit 1002eef

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# oxidizr
22

3+
<a href="https://github.com/jnsgruk/oxidizr/actions/workflows/push.yml"><img src="https://github.com/jnsgruk/oxidizr/actions/workflows/push.yml/badge.svg"></a>
4+
<a href="https://github.com/jnsgruk/oxidizr/actions/workflows/release.yml"><img src="https://github.com/jnsgruk/oxidizr/actions/workflows/release.yml/badge.svg"></a>
5+
36
`oxidizr` is a command-line utility for managing system experiments that replace traditional Unix utilities with modern Rust-based alternatives on Ubuntu systems.
47

58
It currently supports the following experiments:
@@ -18,7 +21,18 @@ By default, the `coreutils` and `sudo-rs` experiments are enabled because they'r
1821
> `oxidizr` is an experimental tool to help developers and tinkerers play with relatively new alternatives to core system utilities. It may cause a loss of data, or prevent your system from booting, so use with caution!
1922
<!-- prettier-ignore-end -->
2023
21-
You can install `oxidizr` using `cargo`:
24+
You can install `oxidizr` by downloading binaries from the Github [releases](https://github.com/jnsgruk/oxidizr/releases/latest). Releases are currently published for `amd64` and `aarch64`.
25+
26+
The following will establish the latest released version, download the archive and extract the `oxidizr` binary to `/usr/bin/oxidizr`.
27+
28+
```bash
29+
# Get the latest release
30+
latest="$(curl -s "https://api.github.com/repos/jnsgruk/oxidizr/releases/latest" | jq -r '.name')"
31+
# Download and install to /usr/bin/oxidizr
32+
curl -sL "https://github.com/jnsgruk/oxidizr/releases/download/$latest/oxidizr_Linux_$(uname -m).tar.gz" | sudo tar -xvzf - -C /usr/bin oxidizr
33+
```
34+
35+
Or you can build and install `oxidizr` using `cargo`:
2236

2337
```bash
2438
cargo install --git https://github.com/jnsgruk/oxidizr

0 commit comments

Comments
 (0)