Skip to content

Commit

Permalink
chore: update README (#40)
Browse files Browse the repository at this point in the history
* chore: update README

Signed-off-by: lstocchi <lstocchi@redhat.com>

* Update README.md

Signed-off-by: Luca Stocchi <49404737+lstocchi@users.noreply.github.com>

---------

Signed-off-by: lstocchi <lstocchi@redhat.com>
Signed-off-by: Luca Stocchi <49404737+lstocchi@users.noreply.github.com>
  • Loading branch information
lstocchi committed May 2, 2024
1 parent ce9a13f commit d51b1c8
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# podman-desktop-extension-minikube
# Minikube Extension

The Minikube extension adds support for https://minikube.sigs.k8s.io/docs/. It allows users to create Kubernetes clusters running on top of the container engine.

## Topics
- [Installation](#installation)
- [Contributing](#contributing)
- [Feedback](#feedback)

## Installation

You can install the Minikube extension directly inside Podman Desktop.

Go to Extensions > Catalog > Install minikube.

![](https://github.com/containers/podman-desktop-media/raw/minikube/gifs/install_minikube_extension.gif)

## Contributing

Want to help develop and contribute to the Minikube extension?

You can use `yarn watch --extension-folder` from the Podman Desktop directory to automatically rebuild and test the Minikube extension:

```sh
git clone https://github.com/containers/podman-desktop
git clone https://github.com/containers/podman-desktop-extension-minikube
cd podman-desktop-extension-minikube
yarn install
yarn watch
cd ../podman-desktop
yarn watch --extension-folder ../podman-desktop-extension-minikube
```

## Feedback

You can provide your feedback on the extension by creating [an issue on this repository](https://github.com/containers/podman-desktop-extension-minikube/issues).

0 comments on commit d51b1c8

Please sign in to comment.