diff --git a/README.md b/README.md index 08829d0..c63d48e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ ![Build](https://github.com/adevinta/zoe/workflows/Build%20test/badge.svg) +[![Chocolatey](https://img.shields.io/chocolatey/v/zoe.svg)](https://chocolatey.org/packages/zoe) # Zoe: The Kafka CLI for humans diff --git a/docs/install/chocolatey.md b/docs/install/chocolatey.md new file mode 100644 index 0000000..91207cf --- /dev/null +++ b/docs/install/chocolatey.md @@ -0,0 +1,39 @@ +[![Chocolatey](https://img.shields.io/chocolatey/v/zoe.svg)](https://chocolatey.org/packages/zoe) + +# Windows install as a Chocolatey package + +## Install Chocolatey + +You only need to have a proper [Chocolatey install](https://chocolatey.org/install). + +## Java requirements + +Java 11 or higher is required in order to install the runtime-less tarball packages. They only ship with the Zoe CLI jar. + +If you don't have java installed already, you can use [sdkman](https://sdkman.io/) for an easy install and version management of the JDK. If you don't want to install java you can try one of the platform packages provided in the previous section. + +Once java is installed, proceed with the `zoe` install : + +``` +choco install zoe +```` + +To upgrade : + +``` +choco upgrade zoe +``` + +To uninstall : + +``` +choco uninstall zoe +``` + +## Init zoe configuration + +```bash +zoe config init +``` + +You are now ready to use zoe. Go to the [guides section](../guides) to start learning zoe. \ No newline at end of file diff --git a/docs/install/overview.md b/docs/install/overview.md index 435b29c..6c45673 100644 --- a/docs/install/overview.md +++ b/docs/install/overview.md @@ -6,3 +6,4 @@ There are several ways to install zoe depending on your needs and the operation - [Homebrew](homebrew.md): Zoe can also be installed using Homebrew on MacOs and Linux environments. Installed packages do not contain the JDK though, so the host machine is required to have a JDK 11 or higher. - [Manual tarball install](tarball.md): If none of the above options are available for you, Zoe provides tarballs ready to be used in all platforms (including Windows). The host machine is required to have a JDK 11 or higher. - [Docker](docker.md): Zoe can also be used with docker. We provide ready to use images automatically built for each release. +- [Windows with Chocolatey](chocolatey.md): Zoe can also be installed as a [Chocolatey package](https://community.chocolatey.org/packages/zoe). Ready to use package are built for each release. \ No newline at end of file