Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add homebrew installation note #468

Merged
merged 3 commits into from
Feb 10, 2024
Merged

docs: add homebrew installation note #468

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a68aa06
docs: add homebrew installation note
chenrui333 Feb 9, 2024
371620d
Apply suggestions from code review
sarub0b0 Feb 10, 2024
f11843a
adopt pr suggestion
chenrui333 Feb 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Release](https://img.shields.io/github/v/release/sarub0b0/kubetui)]()
[![Test](https://github.com/sarub0b0/kubetui/actions/workflows/test.yml/badge.svg)](https://github.com/sarub0b0/kubetui/actions/workflows/test.yml)

Kubetui is a terminal user interface (TUI) tool designed for monitoring Kubernetes resources.
Kubetui is a terminal user interface (TUI) tool designed for monitoring Kubernetes resources.
It provides an easy-to-use interface for developers and operators to access important information about their applications and infrastructure.
chenrui333 marked this conversation as resolved.
Show resolved Hide resolved

<details>
Expand Down Expand Up @@ -43,7 +43,17 @@ It provides an easy-to-use interface for developers and operators to access impo

To install Kubetui, you can use the following methods:

1. **Using `cargo install`:** Kubetui is available on [crates.io](https://crates.io/crates/kubetui), the official Rust package registry. Install it by running the following command:
### **Using `brew`**
sarub0b0 marked this conversation as resolved.
Show resolved Hide resolved

[Kubetui](https://formulae.brew.sh/formula/kubetui) is available on [Homebrew](https://brew.sh/), the package manager for macOS and Linux. Install it by running the following command:

```shell
brew install kubetui
```

### **Using `cargo install`**
sarub0b0 marked this conversation as resolved.
Show resolved Hide resolved

Kubetui is available on [crates.io](https://crates.io/crates/kubetui), the official Rust package registry. Install it by running the following command:

```shell
# Install with rustls version
Expand All @@ -59,7 +69,9 @@ To install Kubetui, you can use the following methods:

Make sure you have [Rust](https://www.rust-lang.org/tools/install) and [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) installed before running the command. If you choose the OpenSSL version, you will need to have the OpenSSL library installed as well.

2. **Downloading the binary:** Alternatively, you can download the precompiled binary from the [GitHub Release page](https://github.com/sarub0b0/kubetui/releases) that matches your operating system. Once downloaded, you can run the binary directly without any additional installation steps.
### **Downloading the binary:**
sarub0b0 marked this conversation as resolved.
Show resolved Hide resolved

Alternatively, you can download the precompiled binary from the [GitHub Release page](https://github.com/sarub0b0/kubetui/releases) that matches your operating system. Once downloaded, you can run the binary directly without any additional installation steps.

Choose the method that suits your needs and preferences.

Expand Down