From d408bf09c829cb7a090db9a3b1ba4bcf53b9f341 Mon Sep 17 00:00:00 2001 From: Zach <33015448+zachary62@users.noreply.github.com> Date: Fri, 4 Apr 2025 17:42:17 -0400 Subject: [PATCH] Update README.md --- README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index 4331419..5793599 100644 --- a/README.md +++ b/README.md @@ -60,17 +60,14 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket 1. Clone this repository 2. Install dependencies: - ```bash pip install -r requirements.txt ``` 3. Generate a complete codebase tutorial by running the main script: - ```bash python main.py https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000 ``` - - `repo_url` - URL of the GitHub repository (required) - `-n, --name` - Project name (optional, derived from URL if omitted) - `-t, --token` - GitHub token (or set GITHUB_TOKEN environment variable) @@ -78,12 +75,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket - `-i, --include` - Files to include (e.g., "*.py" "*.js") - `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*") - `-s, --max-size` - Maximum file size in bytes (default: 100KB) - -- Crawl GitHub repositories at specific commits or branches -- Filter files by patterns (include/exclude) -- Set maximum file size limits -- Generate relative paths for simpler directory structures - + The application will crawl the repository, analyze the codebase structure, generate tutorial content, and save the output in the specified directory (default: ./output).