From 7434e170206b1bfdc556ca1e185ccabe98c9d779 Mon Sep 17 00:00:00 2001
From: kenna-bmcdevitt <bmcdevitt@kennasecurity.com>
Date: Tue, 21 Jan 2025 10:13:26 -0600
Subject: [PATCH] update readme

---
 README.md | 37 +++++++++++++++++++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index da4a9fb..275d6f3 100644
--- a/README.md
+++ b/README.md
@@ -81,5 +81,38 @@ python github_searcher.py --query QUERY --search_type SEARCH_TYPE [--get_file_co
 
 6. Use Docker Compose to search for a specific CVE-ID and output results to a file:
     ```sh
-    docker-compose run --rm github_searcher python3 /usr/src/app/github_searcher.py --query=CVE-2024-5932 --search_type=in-repo-name --get_open_issues --get_open_pull_requests --get_file_contents --json > cve-2024-5932
-    ```
\ No newline at end of file
+    docker-compose run --rm app python3 /usr/src/app/github_searcher.py --query=CVE-2024-5932 --search_type=in-repo-name --get_open_issues --get_open_pull_requests --get_file_contents --json > cve-2024-5932
+    ```
+
+7. Search for a specific repository by name and get open issues:
+    ```sh
+    python github_searcher.py --query "torvalds/linux" --search_type in-repo-name --get_open_issues
+    ```
+
+8. Search for a specific repository by name and get open pull requests:
+    ```sh
+    python github_searcher.py --query "apple/swift" --search_type in-repo-name --get_open_pull_requests
+    ```
+
+9. Search for a specific repository by name and get file contents:
+    ```sh
+    python github_searcher.py --query "microsoft/vscode" --search_type in-repo-name --get_file_contents
+    ```
+
+10. Search for a specific repository by name and output results in JSON format:
+    ```sh
+    python github_searcher.py --query "facebook/react" --search_type in-repo-name --json
+    ```
+
+## Output
+
+The output will include the following details based on the flags provided:
+
+- **Repository URL**: The URL of the repository.
+- **Open Issues**: A list of open issues with their titles and URLs.
+- **Open Pull Requests**: A list of open pull requests with their titles and URLs.
+- **File Contents**: A list of file contents with their names, SHAs, sizes, encodings, and URLs.
+
+## License
+
+This project is licensed under the MIT License.
\ No newline at end of file