Merge pull request #66 from mtimkovich/bump

bump version, rearrange readme
marcusbuffett · Apr 4, 2023 · 2db7c4e · 2db7c4e
2 parents cc36e11 + 87faf77
commit 2db7c4e
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 37 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git 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 <[email protected]>"]
 description = "Rename your files using your favorite text editor"
 homepage = "https://github.com/marcusbuffett/pipe-rename"

diff --git 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:
+    <FILES>...
+
+
+OPTIONS:
+    -c, --rename-command <COMMAND>
+            Optionally set a custom rename command, like 'git mv'
+
+    -e, --editor <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:
-    <FILES>...
-
-
-OPTIONS:
-    -c, --rename-command <COMMAND>
-            Optionally set a custom rename command, like 'git mv'
-
-    -e, --editor <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 ✨
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->