diff options
Diffstat (limited to 'src/README.md')
-rw-r--r-- | src/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..b94d050 --- /dev/null +++ b/src/README.md @@ -0,0 +1,34 @@ +# cve-poc-mon + +## Building + +Build with `go build`, `make` or `make <target>`. + +Available targets: + +- linux-amd64 +- linux-386 +- windows-amd64 +- windows-386 +- darwin-amd64 +- darwin-arm64 + +## Running + +``` +$ ./cve-poc-mon -h +This program searches GitHub for public repositories created today that match the keyword 'cve-<current_year>'. +It then clones these repositories to a specified directory, keeps track of them to avoid duplicates, and updates a README.md file with their URLs and descriptions. + +Usage: + -auto-update + Automatically update previously cloned repositories + -cloneDir string + Directory to clone repositories (default "cve-pocs") + -clonedList string + File to store cloned repository URLs (default "cve-pocs.txt") + -silent + Suppress update messages + -token string + GitHub API token +``` |