aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Segundo2023-05-21 22:01:30 +0200
committerChristian Segundo2023-05-21 22:03:28 +0200
commit0868dce02318d8026bc3b89d904779d90eb62a98 (patch)
tree14906d8bbb14f7a2138060448838f434ce01b7db
parent0d927a66dd793e15cd24294ab9f0a7c8b9953e9c (diff)
downloadkontext-0868dce02318d8026bc3b89d904779d90eb62a98.tar.gz
update README
-rw-r--r--README41
1 files changed, 41 insertions, 0 deletions
diff --git a/README b/README
index e69de29..b9637eb 100644
--- a/README
+++ b/README
@@ -0,0 +1,41 @@
+kontext
+=======
+
+kontext sets per shell Kubernetes contexts to allow
+power users to work on multiple clusters at the same time.
+
+Dependencies
+------------
+
+* GNU getopt
+* bash
+* kubectl
+
+Installation
+------------
+
+Installing kontext requires a working Autotools setup.
+
+a) To install it from a cloned repository:
+
+ $ aclocal
+ $ autoconf
+ $ automake --add-missing
+ $ ./configure
+ $ make install
+
+Enabling kontext
+-------------------
+
+Add the following alias to your shell:
+
+ alias kontext='source kontext'
+
+Usage
+-----
+
+Just use the kontext command followed by a context:
+
+ $ kontext foo
+
+See `kontext --help` and kontext(1) man page for more information.