diff --git a/README.md b/README.md index 5728e58..3adc354 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,8 @@ ## Reference +The CLI takes in 2 arguments, the first being the `regex` expression for matching the filename and the second being the directory to search in. If the directory is not mentioned, the root directory of your system is chosen and all the files in your system are searched. + +If there are any permission errors while searching, they are simply ignored. + + diff --git a/assets/dive.gif b/assets/dive.gif new file mode 100644 index 0000000..1eff607 Binary files /dev/null and b/assets/dive.gif differ