Skip to content

Commit d17e5b4

Browse files
committed
chore(readme): Move utilities section to dedicated /docs md
This commit moves the `utilities` section of the `README.md` to a dedicated `/docs` document to keep the README focused on installation and configuration of the plugin.
1 parent d695c60 commit d17e5b4

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,3 @@ The plugin supports the following `global` configuration options:
4545
| `@tmux_kubenv_color_context_bg` | The _background color_ of the _context_ section | `#00DCEE` |
4646
| `@tmux_kubenv_color_namespace_fg` | The _foreground color_ of the _namespace_ section | `#124F76` |
4747
| `@tmux_kubenv_color_namespace_bg` | The _background color_ of the _namespace_ section | `#D69F00` |
48-
49-
## Utilities
50-
51-
Helper utilities supporting the plugin functionality.
52-
53-
### `tmux_kubenv_precmd_hook` [hook](https://zsh.sourceforge.io/Doc/Release/Functions.html#Hook-Functions) function
54-
55-
A [ZSH](https://www.zsh.org) `precmd` [hook](https://zsh.sourceforge.io/Doc/Release/Functions.html#Hook-Functions) function that automatically updates the plugin context based on the current `KUBECONFIG` in use.
56-
To allow configurable _enable_/_disable_ capability to the hook, two additional functions are provided:
57-
58-
- `tmux_kubenv_precmd_hook_enable` - __adds__ the `hook` to the `precmd_functions` list
59-
- `tmux_kubenv_precmd_hook_disable` - __removes__ the `hook` from the `precmd_functions` list

docs/utils.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Utilities
2+
3+
Helper utilities supporting the plugin functionality.
4+
5+
## `tmux_kubenv_precmd_hook` [hook](https://zsh.sourceforge.io/Doc/Release/Functions.html#Hook-Functions) function
6+
7+
A [ZSH](https://www.zsh.org) `precmd` [hook](https://zsh.sourceforge.io/Doc/Release/Functions.html#Hook-Functions) function that automatically updates the plugin context based on the current `KUBECONFIG` in use.
8+
To allow configurable _enable_/_disable_ capability to the hook, two additional functions are provided:
9+
10+
- `tmux_kubenv_precmd_hook_enable` - __adds__ the `hook` to the `precmd_functions` list
11+
- `tmux_kubenv_precmd_hook_disable` - __removes__ the `hook` from the `precmd_functions` list

0 commit comments

Comments
 (0)