From b6212d690afcc69a806437de6a95b61f881a1298 Mon Sep 17 00:00:00 2001 From: Ali <36738510+MrAliSalehi@users.noreply.github.com> Date: Mon, 19 Jun 2023 19:29:55 +0330 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 19d6ac6..3b02a7c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # simple-grip simple `grip-like` program that allows you to search files/directories with a specific pattern + + +# use +``` + base path to search + regex pattern, its recommended to wrap it around single quotes(') + +Options: + -r, --reverse show anything that doesnt match the patterns + -s search target, can either be name of the files/directories or file contents [default: names] [possible values: names, contents] + -t set max thread count [default: 0] + -d max directory depth to search [default: 3] + -h, --help Print help + -V, --version Print version +``` +- for example: + +`simple-grip /path/to/dir 'pattern\+' -s names -t 3 -d 4` + +will go in `/path/to/dir` and search for the files/directories that matches the `'pattern\+' ` with maximum 3 threads and `tree-depth` of 3