Skip to content

Commit

Permalink
docs: fix plugin naming in README
Browse files Browse the repository at this point in the history
  • Loading branch information
wI2L committed Jan 26, 2022
1 parent 1f46b6d commit 0e22951
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `kubectl vpa-recommendation`
# kubectl vpa-recommendation

<p align="left">
<a href="https://github.com/wI2L/kubectl-vpa-recommendation/actions"><img src="https://github.com/wI2L/kubectl-vpa-recommendation/workflows/ci/badge.svg"></a>
Expand Down Expand Up @@ -27,7 +27,7 @@ Head to the [releases](https://github.com/wI2L/kubectl-vpa-recommendation/releas

### Build from source

:warning: `kubectl-vpa-recommendation` requires [Go 1.17+](https://golang.org/doc/install) to build.
:warning: The plugin requires [Go 1.17+](https://golang.org/doc/install) to build.

To build the plugin yourself from the source, use the following commands:

Expand All @@ -37,7 +37,7 @@ $ cd kubectl-vpa-recommendation
$ make build
```

It creates a single binary file for the host machine platform/architecture in the `dist/` folder. Move it somewhere within your `$PATH`, such as `$GOPATH/bin`. You can then invoke it directly (`kubectl-vpa-recommendation`), or via `kubectl` (`kubectl vpa-recommendation`).
It creates a single binary file for the host machine platform/architecture in the `dist/` folder. Move it somewhere within your `$PATH`, such as `$GOPATH/bin`. You can then invoke it directly (`kubectl-vpa-recommendation`), or via `kubectl` (`kubectl vpa recommendation`).

## Usage

Expand Down Expand Up @@ -70,7 +70,7 @@ Apart from the flags defined by the [`genericclioptions`](https://pkg.go.dev/k8s
To view the full list of available options, use the following command:

```shell
$ kubectl vpa-recommendation --help
$ kubectl vpa recommendation --help
```

## Limitations
Expand Down

0 comments on commit 0e22951

Please sign in to comment.