Skip to content

Commit 34be237

Browse files
committed
docs: Update README with real Chrome Web Store info and honest origin story
- Add Chrome Web Store badges and links - Explain honest origin: built for self, Google approved, 9 downloads - Clarify .txt as pre-cursor to .faf format - Update install instructions with real store link - Add real-world usage example showing the value - Replace generic marketing with authentic developer story
1 parent a775420 commit 34be237

1 file changed

Lines changed: 46 additions & 31 deletions

File tree

README.md

Lines changed: 46 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,66 @@
1-
# 🚀 FAF - Fast AF AI Context Extraction
1+
# 🚀 FAF Chrome Extension - Fast AF Context Extraction
22

3-
> **Extract perfect AI context in 0.3 seconds. Stop FAFfing About.**
3+
> **Grab any codebase as .txt in one click. GitHub, Monaco, StackBlitz, GitLab—every dev's dream when you need it.**
44
5-
FAF is a lightning-fast Chrome extension and emerging open standard for AI context extraction. It intelligently analyzes codebases, documentation, and development environments to generate structured `.faf` files that provide AI assistants with the perfect context for your project.
5+
Google-approved Chrome extension that extracts code context from ANY development environment. Monaco editor? React sandbox? GitHub repo? One click → perfect .txt context → ready for Claude, Cursor, or any AI.
66

7-
[![Version](https://img.shields.io/badge/version-1.0.1-blue.svg)](https://github.com/Wolfe-Jam/faf-production)
8-
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
9-
[![Chrome Extension](https://img.shields.io/badge/chrome-extension-orange.svg)](https://chrome.google.com/webstore)
7+
[![Chrome Web Store](https://img.shields.io/chrome-web-store/v/lnecebepmpjpilldfmndnaofbfjkjlkm)](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
9+
[![Google Approved](https://img.shields.io/badge/Google-Approved-success)](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm)
10+
[![Downloads](https://img.shields.io/chrome-web-store/users/lnecebepmpjpilldfmndnaofbfjkjlkm)](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm)
1011

11-
## ✨ What is FAF?
12+
## 🎯 Why This Exists
1213

13-
FAF (**F**ast **A**F) solves the universal problem every developer faces: **providing AI assistants with the right context**. Instead of manually copying and pasting code snippets, file structures, and project details, FAF:
14+
**The Problem:** You're testing something in StackBlitz, you need to ask Claude about it, but copying code manually is a pain.
1415

15-
- 🔍 **Intelligently analyzes** your codebase across 15+ platforms (GitHub, Monaco, CodeMirror, etc.)
16-
- 📊 **Scores context quality** from 0-100% based on completeness and relevance
17-
- 📋 **Copies structured context** directly to your clipboard in seconds
18-
- 🎯 **Works everywhere** - any website, any development environment
19-
-**Blazing fast** - Full extraction in under 300ms
16+
**The Solution:** One click. Entire codebase → clipboard as clean .txt. Works on GitHub, Monaco editor, React playgrounds, GitLab, anywhere.
2017

21-
## 🎯 Quick Start
18+
**My Story:** Built it for myself while testing. Needed it. Google approved it. Success. Nine downloads. Zero reviews. But it's **top-notch** as you'd expect—when you need it, you NEED it.
2219

23-
### 1. Install the Chrome Extension
20+
**The Format:** The .txt output is a **pre-cursor to .faf**—any FAF tool gobbles it up like an appetizer. It's the universal handoff format for AI context.
2421

22+
## ✨ What It Does
23+
24+
- 🔍 **Works on 15+ platforms** - GitHub, Monaco, CodeMirror, StackBlitz, GitLab, Replit
25+
- 📋 **One-click extraction** - Entire codebase → clipboard in <300ms
26+
- 🎯 **Clean .txt format** - Human-readable, AI-ready, .faf-compatible
27+
-**Zero config** - Install, click icon, done
28+
- 🛡️ **Google Approved** - Passed security review, live in Chrome Web Store
29+
30+
## 🚀 Quick Start
31+
32+
### 1. Install from Chrome Web Store
33+
34+
**[→ Install FAF Extension](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm)**
35+
36+
Or build from source:
2537
```bash
26-
# Clone and build locally (Chrome Web Store submission pending)
27-
git clone https://github.com/Wolfe-Jam/faf-production.git
28-
cd faf-production
29-
npm install
30-
npm run build
38+
git clone https://github.com/Wolfe-Jam/faf-chrome-extension.git
39+
cd faf-chrome-extension
40+
npm install && npm run build
3141
```
3242

33-
Then load `dist/` as an unpacked extension in Chrome.
43+
### 2. Use It
3444

35-
### 2. Extract Context Instantly
45+
1. Open any GitHub repo, Monaco editor, StackBlitz, etc.
46+
2. Click FAF extension icon 🚀
47+
3. Click "Extract Context"
48+
4. Context copied to clipboard as clean .txt
49+
5. Paste into Claude, Cursor, or any AI
3650

37-
1. **Navigate** to any GitHub repo, CodeSandbox, or development site
38-
2. **Click** the FAF extension icon ⚡
39-
3. **Hit** "Extract AI Context"
40-
4. **Paste** the perfect context into ChatGPT, Claude, or any AI assistant
41-
42-
### 3. Get Better AI Responses
51+
### 3. Real Example
4352

53+
**Without FAF:**
54+
```
55+
You: "Help with this React component"
56+
AI: "Which component? Show me the code"
57+
You: [manually copies files one by one]
4458
```
45-
🤖 Instead of: "Help me with my React app"
46-
✅ With FAF: [Pastes comprehensive .faf context with file structure, dependencies, platform details]
4759

48-
Result: AI instantly understands your project structure, tech stack, and current context.
60+
**With FAF:**
61+
```
62+
You: [pastes FAF .txt] "Help with this React component"
63+
AI: "I see you're using React 18 with Vite, here's what I'd change in Button.tsx..."
4964
```
5065

5166
## 📋 Supported Platforms

0 commit comments

Comments
 (0)