From: Eshel Yaron <me@eshelyaron.com>
Date: Wed, 7 Aug 2024 09:38:11 +0000 (+0200)
Subject: ; * kubed.el: Update Commentary.
X-Git-Tag: v0.3.2~27
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=5c1dd95cc5e9e552a92ac1a2c8ca6896ed93775c;p=kubed.git

; * kubed.el: Update Commentary.
---

diff --git a/kubed.el b/kubed.el
index a9af13a..073e6d8 100644
--- a/kubed.el
+++ b/kubed.el
@@ -22,21 +22,29 @@
 ;; Similar commands are defined for other types of resources as well.
 ;;
 ;; This library interacts with Kuberenetes via `kubectl', and uses the
-;; current `kubectl' context and namespace.  To change your current
-;; Kuberenetes context or namespace, use `kubed-use-context' and
-;; `kubed-set-namespace'; all resource lists are updated automatically
-;; after you do so.  The prefix keymap `kubed-prefix-map' gives you
-;; quick access to these and other useful commands, you may want to bind
-;; it globally to a convenient key with `keymap-global-set':
+;; current `kubectl' context and namespace by default.  To change your
+;; current context or namespace, use commands `kubed-use-context' and
+;; `kubed-set-namespace' respectively; you can also interact with
+;; resources in other namespaces without changing your default
+;; namespace, for example you can call `kubed-list-pods' with a prefix
+;; argument to choose another namespace for listing pods.  The prefix
+;; keymap `kubed-prefix-map' gives you quick access to these and other
+;; useful commands, you may want to bind it globally to a convenient key
+;; with `keymap-global-set':
 ;;
 ;;   (keymap-global-set "C-c k" 'kubed-prefix-map)
 ;;
+;; In addition, the command `kubed-transient' lets you explore various
+;; Kubernetes operations with a transient menu interface.  You may also
+;; want to enable `kubed-menu-bar-mode', which add a "Kubernetes" menu
+;; to your menu-bar with many useful entries.
+;;
 ;; If you want to work with more or different types of Kubernetes
 ;; resources, use the macro `kubed-define-resource'.  This macro defines
 ;; some common functions and commands that'll get you started with ease.
 ;;
-;; You may also want to try out the companion library `kubed-transient',
-;; which provides transient menus for some of the commands defined here.
+;; For more information, see the Kubed manual at (info "(kubed)Top"), or
+;; online at https://eshelyaron.com/kubed.html
 
 ;;; Code: