From 5b585c2b5d445038c3a4fc15639dc9c8972a37a6 Mon Sep 17 00:00:00 2001 From: Joel Spadin Date: Sun, 20 Oct 2024 13:34:20 -0500 Subject: [PATCH] docs: Document how to update to latest version Added a section to the readme showing how to update ZMK CLI. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1198b80..e3e715d 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,14 @@ It should print a help message if everything installed correctly. On Linux, you may get an error saying you need to install another package such as `python3.10-venv`. If so, follow the instructions in the error message, then try the above commands again. +## Update ZMK CLI + +If you have already installed ZMK CLI, you can update to the latest version with the following command: + +```sh +pipx upgrade zmk +``` + # Usage All ZMK CLI commands start with `zmk`. Run `zmk --help` for general usage instructions. For help with a specific subcommand, add `--help` after the subcommand, e.g. `zmk init --help`.