Skip to content

Commit 631710a

Browse files
ekristencorybekk
authored andcommitted
docs: improving the installation docs
1 parent 2bf1f45 commit 631710a

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

docs/installation.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,45 @@
11
# Install
22

3-
## Install the pre-compiled binary
3+
Preferred installation order is the following:
44

5-
### Homebrew Tap (MacOS/Linux)
5+
1. [GitHub Release](#github-releases-preferred)
6+
2. [ekristen's homebrew tap](#ekristens-homebrew-tap-macoslinux)
7+
3. [Homebrew Core](#homebrew-core-macoslinux)
8+
9+
Docker images are also available via the GitHub Container Registry.
10+
11+
## GitHub Releases (preferred)
12+
13+
!!! success - "Recommended"
14+
This supports all operating systems and most architectures.
15+
16+
You can download pre-compiled binaries from the [releases](https://github.com/ekristen/aws-nuke/releases) page.
17+
18+
## ekristen's Homebrew Tap (MacOS/Linux)
19+
20+
!!! info
21+
I control this tap, and it sources the binaries directly from the GitHub releases. However, it only supports MacOS.
622

723
```console
824
brew install ekristen/tap/aws-nuke
925
```
1026

11-
!!! warning "Brew Warning"
12-
`brew install aws-nuke` will install the rebuy-aws version of aws-nuke, which is not the same as this version.
13-
14-
## Releases
27+
## Homebrew Core (MacOS/Linux)
1528

16-
You can download pre-compiled binaries from the [releases](https://github.com/ekristen/aws-nuke/releases) page.
29+
!!! note
30+
I do not control the Homebrew Core formula, so it may not be up to date. Additionally, it is not compiled with
31+
goreleaser, instead it is compiled with the Homebrew build system which does not build it in the same way, for
32+
example it does not compile it statically.
1733

34+
```console
35+
brew install aws-nuke
36+
```
1837
## Docker
1938

2039
Registries:
2140

2241
- [ghcr.io/ekristen/aws-nuke](https://github.com/ekristen/aws-nuke/pkgs/container/aws-nuke)
2342

24-
You can run **aws-nuke** with Docker by using a command like this:
25-
2643
## Source
2744

2845
To compile **aws-nuke** from source you need a working [Golang](https://golang.org/doc/install) development environment and [goreleaser](https://goreleaser.com/install/).

0 commit comments

Comments
 (0)