Skip to content

docs: improve README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# Github Codebase Tutorial Generator

A Cloudflare Worker that automatically generates comprehensive tutorials from GitHub repositories using AI. It crawls repositories, identifies key abstractions, analyzes relationships, and creates structured markdown tutorials with chapters, code examples, and diagrams.
Expand Down Expand Up @@ -34,7 +36,7 @@ A Cloudflare Worker that automatically generates comprehensive tutorials from Gi
**Alternative: Use Cloudflare AI instead of Gemini**

- Uncomment AI binding in `wrangler.jsonc`
- Uncomment `AI: Ai;` in `src/worker/utils/types.ts`
- Uncomment `AI: Ai;` in `src/worker/index.ts`
- Uncomment Cloudflare AI code in `src/worker/utils/utils.ts` (lines 4-12)

3. **Setup Cloudflare resources:**
Expand Down