From e36089f260645bb531dfd78f90370f8da5f8f869 Mon Sep 17 00:00:00 2001 From: "dr.max" Date: Thu, 15 Aug 2019 23:16:09 -0700 Subject: [PATCH] Add reference to plugin in README.md (#363) * Add reference to plugin in README.md Working on various plugins docs. This is first of three PRs. * typo and clarification * fix links --- docs/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 3589e103a..6238c9baf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -76,13 +76,21 @@ Examples: kn revision list --service srvc # CHECK this since current command does not have --service flag ``` +### Plugins + +Kn supports plugins, which allow you to extend the functionality of your Kn installation with custom commands as well as shared commands that are not part of the core distribution of Kn. + +Plugins follow a similar architecture to [kubectl plugins](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/) with some small differences. One key difference is that Kn plugins can either live in your `PATH` or in a chosen and specified directory. [Kn plugins](plugins.md) shows how to install and create new plugins as well as giving some examples and best practices. + +To see what plugins are installed on your machine, you can use the [`plugin`](cmd/kn_plugin.md) command group's [`list`](cmd/kn_plugin_list.md) command. + ### Utilities These are commands that provide some useful information to the user. * The `kn help` command displays a list of the commands with helpful information. * The [`kn version`](cmd/kn_version.md) command will display the current version of the `kn` build including date and Git commit revision. -* The [`kn completion`](cmd/kn_completion.md) command will output a BASH completion script for `kn` to allow command completions with tabs. +* The `kn completion` command will output a BASH completion script for `kn` to allow command completions with tabs. ### Common Flags