From bfb26b61cf990ca0a5c10a1c58cddbb919ed5e73 Mon Sep 17 00:00:00 2001 From: askiiart <dev@askiiart.net> Date: Thu, 30 Jan 2025 16:38:39 -0600 Subject: [PATCH] fix readme to reflect cli changes --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d799c99..5a0e19c 100644 --- a/README.md +++ b/README.md @@ -72,14 +72,11 @@ A port of Cat2Text to Rust, with extra functionality, better documentation, and Usage: cat2text <COMMAND> Commands: - generate-bash-completions Generate bash completions - generate-zsh-completions Generate zsh completions - generate-fish-completions Generate fish completions - generate-powershell-completions Generate PowerShell completions, - encode Encodes text/data to mrow~ - decode Decodes mrow~ to text/data - benchmark - help Print this message or the help of the given subcommand(s) + gen-completion Generate shell completions + encode Encodes text/data to mrow~ + decode Decodes mrow~ to text/data + benchmark + help Print this message or the help of the given subcommand(s) Options: -h, --help Print help @@ -103,4 +100,4 @@ For example, `cat2text encode 'i love cats'` to encode `i love cats` in text mod ### Shell completions -To generate shell completions, you can run `cat2text generate-$(basename $SHELL)-completions | source` on *nix systems using bash, zsh, or fish. +To generate shell completions, you can run `cat2text gen-completion $(basename $SHELL) | source` on *nix systems using bash, zsh, or fish.