diff --git a/README.md b/README.md index f5ee89d8..7d9b3f54 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,14 @@

+

kftray and kftui are independent, cross-platform applications. They help you set up and manage multiple port-forwarding settings easily. Both apps are part of the same open-source project and aim to make working with Kubernetes easier. kftray has a desktop interface, while kftui has a terminal interface, so you can choose the one that suits you best.

-## ❓ Why +## Why `kftray` and `kftui` were made to fix common problems with Kubernetes port forwarding. The usual kubectl port-forward command can be unreliable. For example, if a pod dies, it needs manual reconnection. It also has trouble setting up many port forwards at once and doesn't support UDP services. @@ -30,6 +31,8 @@
+
+
@@ -47,8 +50,11 @@
+
+
+ -## ✨ Features +## Features - **Resilient Port Forwarding Connection:** Ensures continuous service even if a pod dies by reconnecting to another running pod automatically. - **One-Click Multiple Port Forwards:** Allows for the setup of several port forwarding instances simultaneously with a single click. @@ -58,6 +64,8 @@ - **GitHub Sync:** Keep your configurations saved on GitHub and share or synchronize them in a GitOps style. _(Currently available only in the kftray desktop app)_ - **Auto Import:** Automatically import Kubernetes service configurations based on specific annotations. An example with an explanation can be found in this repo: https://github.com/hcavarsan/kftray-k8s-tf-example +
+
| Feature | kftray (Desktop App) | kftui (Terminal UI) | @@ -73,6 +81,8 @@
+
+ ## kftray - Desktop App - [INSTALL.md](https://github.com/hcavarsan/kftray/tree/main/docs/kftui/INSTALL.md)