Skip to content

Commit 1725fe5

Browse files
committed
fix(external): Make it more obivious we do not support brew or scoop
Signed-off-by: dark0dave <[email protected]>
1 parent 9789366 commit 1725fe5

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,30 @@ Run the following command in your terminal to install `kubent` using a shell scr
3131
sh -c "$(curl -sSL https://git.io/install-kubent)"
3232
```
3333

34-
*(The script will download latest version and unpack to `/usr/local/bin`).*
34+
*(Unless specified the script will download latest version and unpack to `/usr/local/bin/`).*
35+
36+
> Note: Do not run random scripts from strangers on the internet. Read what the above script does first.
3537
3638
### Manual Installation
3739

3840
You can download the
3941
[latest release](https://github.com/doitintl/kube-no-trouble/releases/latest)
40-
for your platform and unpack manually.
42+
for your cpu architectures and operating system. You can then place it on your path.
43+
44+
We currently maintain, the following operating systems and cpu architectures:
45+
46+
- Linux amd64
47+
- Linux arm64
48+
- Darwin amd64
49+
- Darwin arm64
50+
- Windows amd64
51+
52+
*Historically Windows on arm, has not received the best support. If this changes we may add it.*
4153

4254
### Third-Party Installation
4355

4456
Please note that third-party installation methods are maintained by the community.
45-
The packages may not always be up-to-date with the latest releases of `kubent`.
57+
**The packages may not always be up-to-date with the latest releases of** `kubent`.
4658

4759
#### Homebrew
4860

@@ -216,7 +228,7 @@ The simplest way to build `kubent` is:
216228
git clone https://github.com/doitintl/kube-no-trouble.git
217229
cd kube-no-trouble/
218230
# Build
219-
go build -o bin/kubent cmd/kubent/main.go
231+
go build -o bin/kubent ./...
220232
```
221233

222234
Otherwise there's `Makefile`
@@ -261,6 +273,20 @@ Use imperative, present tense (Add, not ~Added~), capitalize first letter of
261273
summary, no dot at the and. The body and footer are optional. Relevant GitHub
262274
issues should be referenced in the footer in the form `Fixes #123, fixes #456`.
263275

276+
#### Branches
277+
278+
All PRs should be at the HEAD, that is to say we use merge commits with clean history. If not they should be rebased on master, do not merge master into your branches. Do not create branches that already exist, please use a new name. Branches are deleted upon merging. Thank you.
279+
280+
```sh
281+
git fetch -vp
282+
git checkout my-branch
283+
git rebase origin/master
284+
```
285+
286+
We also maintain an author merges policy. We will approve your pr then you can merge it.
287+
288+
Additionally we ask that you do not squash your prs or introduce a large number of commits per feature. If your pr becomes too large we may ask you to split the functionality out into more than one pr.
289+
264290
### Changelog
265291

266292
Changelog is generated automatically based on merged PRs using

0 commit comments

Comments
 (0)