From 87faf773d453592ed7813c6f0680e81b728f4bac Mon Sep 17 00:00:00 2001 From: Max Timkovich Date: Tue, 4 Apr 2023 15:16:00 -0700 Subject: [PATCH] bump version, rearrange readme --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 73 ++++++++++++++++++++++++++++-------------------------- 3 files changed, 40 insertions(+), 37 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 6943fef..d760c52 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -303,7 +303,7 @@ checksum = "029d8d0b2f198229de29dca79676f2738ff952edf3fde542eb8bf94d8c21b435" [[package]] name = "pipe-rename" -version = "1.6.1" +version = "1.6.2" dependencies = [ "ansi_term", "anyhow", diff --git a/Cargo.toml b/Cargo.toml index a8871e8..2fa6e8a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "pipe-rename" -version = "1.6.1" +version = "1.6.2" authors = ["Marcus Buffett "] description = "Rename your files using your favorite text editor" homepage = "https://github.com/marcusbuffett/pipe-rename" diff --git a/README.md b/README.md index ac5856b..da8d8b5 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,44 @@ to run `git mv old new` on each rename, you can do something like this: ls | renamer --rename-command "git mv" ``` +## Helptext + +``` +Takes a list of files and renames/moves them by piping them through an external editor + +USAGE: + renamer [OPTIONS] [FILES]... + +ARGS: + ... + + +OPTIONS: + -c, --rename-command + Optionally set a custom rename command, like 'git mv' + + -e, --editor + Optionally set an editor, overriding EDITOR environment variable and default + + -f, --force + Overwrite existing files + + -h, --help + Print help information + + -p, --pretty-diff + Prettify diffs + + -u, --undo + Undo the previous renaming operation + + -V, --version + Print version information + + -y, --yes + Answer all prompts with yes +``` + ### Caveat emptor **NB:** it makes sense to be aware of the issues `ls` can cause in this @@ -96,41 +134,6 @@ Alas, this could be asking for trouble. If your file names contain line breaks, for example, this could confuse `renamer` which expects a single file name per line when re-reading the edited file. -## Helptext - -``` -Takes a list of files and renames/moves them by piping them through an external editor - -USAGE: - renamer [OPTIONS] [FILES]... - -ARGS: - ... - - -OPTIONS: - -c, --rename-command - Optionally set a custom rename command, like 'git mv' - - -e, --editor - Optionally set an editor, overriding EDITOR environment variable and default - - -f, --force - Overwrite existing files - - -h, --help - Print help information - - -p, --pretty-diff - Prettify diffs - - -V, --version - Print version information - - -y, --yes - Answer all prompts with yes -``` - ## Contributors ✨