diff --git a/README.md b/README.md new file mode 100644 index 0000000..0df1169 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ + +# GOFINDER - Multithreaded file search + +Search for files in your system and display the result in `result.txt` + +## Run Locally + +- Create `search.txt` and write separate search queries in each line + +- Run the command: +```bash +gofinder --d "YOUR PATH" +``` + +- Look for results in `result.txt` \ No newline at end of file