From 092d04dd3482edc3096280a6d25b972e01ab2c0f Mon Sep 17 00:00:00 2001
From: Brendan McDevitt <brendan@mcdevitt.tech>
Date: Sat, 29 Mar 2025 09:59:28 -0500
Subject: [PATCH] updated README

---
 README.md | 35 +++++++++++++++++++++++++++++++----
 1 file changed, 31 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 656f80f..9734e21 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,33 @@
-# Github PoC Exploit Collector
+# GitHub POC Exploit Collector
 
-## Project Overview
-A Rust application that searches a GitHub for repositories related to specific CVE IDs and stores results in yearly directories.
+A tool for collecting and organizing proof-of-concept (POC) code from GitHub repositories that demonstrate security vulnerabilities.
 
-## Project Structure
+## Overview
+
+This tool automates the process of finding, downloading, and organizing security-related POC code from GitHub. It helps security researchers and professionals gather exploit code for analysis, testing, and educational purposes.
+
+## Features
+
+- **Search Automation**: Searches GitHub for repositories containing POC code for specified CVEs or vulnerabilities
+- **Batch Processing**: Handles multiple CVE searches in a single run
+- **Local Organization**: Creates a structured directory of downloaded repositories for easy reference
+
+## Installation
+
+```bash
+# Clone the repository
+git clone https://git.mcdevitt.tech/bpmcdevitt/github_poc_collector.git
+cd github_poc_collector
+```
+
+## Usage
+```bash
+# build it
+cargo build
+
+# run it --recent feed
+cargo run -- --feed recent
+
+# run it --full feed
+cargo run -- --feed full
+```