From dc9eb2fa3bdfc35f3d5ffe75195d473e4aa60ab9 Mon Sep 17 00:00:00 2001
From: Lynnesbian <lynne@bune.city>
Date: Fri, 21 Jan 2022 13:01:39 +1000
Subject: [PATCH] documentation improvements

---
 README.md     | 19 +++++++++++++++++++
 doc/README.md |  8 ++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 doc/README.md

diff --git a/README.md b/README.md
index 1f95f11..c190a74 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,25 @@ You can also manually specify an output format to use:
 fif -O powershell ~/Documents > output.ps1
 ```
 
+#### The `--fix` flag
+
+If, however, you'd rather have fif fix the misnamed files itself, rather than relying on a shell script, you can use 
+the `--fix` flag:
+
+```bash
+# rename any misnamed .jpg files in the user's pictures directory
+fif ~/Pictures --fix -e jpg
+# fix any misnamed files found in the user's downloads
+fif ~/Downloads --fix
+```
+
+By default, fif will avoid taking any potentially destructive actions (renaming a file to a name that already exists).
+This behaviour can be disabled with the `--overwrite` flag, which will instead prompt you to overwrite the existing 
+file. fif will also prompt you to retry on errors.
+
+For more information on how the `--fix` flag works, and how it behaves in conjunction with the `--overwrite` flag 
+and `--prompt` parameter, see [the corresponding wiki page](https://gitlab.com/Lynnesbian/fif/-/wikis/Fix).
+
 ### Logging
 By default, fif will log any info, warnings, and errors encountered during execution. This can be changed with the `-v`
 flag:
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..46762a3
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,8 @@
+Where's the documentation?
+===
+If you're looking for documentation on fif, try checking...
+- The built-in help documentation, by running `fif --help`
+- [The usage section in the README file](https://gitlab.com/Lynnesbian/fif/-/blob/master/README.md#usage), for a 
+  brief overview of fif's functionality and how to use it
+- [The wiki](https://gitlab.com/Lynnesbian/fif/-/wikis/home), for more detailed information on fif's behaviour
+- [Docs.rs](https://docs.rs/fif/latest/fif/), for information pertaining to fif's internals