diff --git a/README.md b/README.md index 8b30e3e..b032869 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# podman-desktop-extension-minikube \ No newline at end of file +# 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). \ No newline at end of file