diff --git a/.gitignore b/.gitignore index 0b188bc..e2aab4f 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,8 @@ target/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + + +# Added by cargo + +/target diff --git a/README.md b/README.md index 36145a5..a9ae3e2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,52 @@ # ferrisfind -Find publicly available files given a company name, download them, and extract the metadata out of them. \ No newline at end of file +Find publicly available files given a company name, download them, and extract the metadata out of them. + +# Usage: + +``` +ferrisfind [OPTIONS] --name --key +-n, --name + company name + +-k, --key + serpapi key + +-p, --pages + number of pages of results to get (note each page is a credit on your sperapi key, defaults to 10) + +-t, --threads + the number of threads to use, will default to the rayon default + +-d, --download-path + folder to download found files into defaults to ./found_files + +-c, --csv + save metadata as csv + +-m, --markdown + save metadata as csv + +-h, --help + Print help (see a summary with '-h') + +-V, --version + Print version +``` + +# Examples: +Find PDFs for google and print metadata to console without saving it to a file: + +`ferrisfind -k {serpapi key} -n google` + +find PDFs for google and save to a csv file: + +`ferrisfind -k {serpapi key} -n google -c ./metadata.csv` + +find PDFs for google and save to a markdwon file: + +`ferrisfind -k {serpapi key} -n google -m ./metadata.md` + +find PDFs for google and save to both a CSV and Markdown file: + +`ferrisfind -k {serpapi key} -n google -c ./metadata.csv -m ./metadata.md`