Skip to content

Commit 40a2938

Browse files
committed
feat: update README
1 parent 4158182 commit 40a2938

File tree

2 files changed

+47
-1
lines changed

2 files changed

+47
-1
lines changed
File renamed without changes.

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,50 @@ Turn any Git repository into a prompt-friendly text ingest for LLMs.
77

88
<a href="https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood" target="_blank" title="Get GitIngest Extension from Chrome Web Store"><img height="48" src="https://github.com/user-attachments/assets/20a6e44b-fd46-4e6c-8ea6-aad436035753" alt="Available in the Chrome Web Store" /></a>
99
<a href="https://addons.mozilla.org/firefox/addon/gitingest/" target="_blank" title="Get GitIngest Extension from Firefox Add-ons"><img height="48" src="https://github.com/user-attachments/assets/c0e99e6b-97cf-4af2-9737-099db7d3538b" alt="Get The Add-on for Firefox" /></a>
10-
<a href="" target="_blank" title="Get GitIngest Extension from Firefox Add-ons"><img height="48" src="https://github.com/user-attachments/assets/204157eb-4cae-4c0e-b2cb-db514419fd9e" alt="Get from the Edge Add-ons" /></a>
10+
<a href="https://microsoftedge.microsoft.com/addons/detail/nfobhllgcekbmpifkjlopfdfdmljmipf" target="_blank" title="Get GitIngest Extension from Firefox Add-ons"><img height="48" src="https://github.com/user-attachments/assets/204157eb-4cae-4c0e-b2cb-db514419fd9e" alt="Get from the Edge Add-ons" /></a>
11+
12+
This extension is part of the GitIngest ecosystem. See [GitIngest.com](https://gitingest.com) or [cyclotruc/gitingest](https://github.com/cyclotruc/gitingest) for more information.
13+
14+
## ✨ Features
15+
16+
- 🚀 One-click access to GitIngest services to get a text ingest
17+
- 📚 Prompt-friendly codebase ingestion
18+
- 📝 Optimized output format for LLM prompts
19+
- 🔍 Statistics about:
20+
- File and directory structure
21+
- Size of the extract
22+
- Token count
23+
- 🔒 Privacy-first, zero data collection (for the extension itself)
24+
- 🤖 Open source, community-driven
25+
26+
## 🛠️ Using
27+
- [WXT](https://github.com/wxt-dev/wxt)
28+
- [TailwindCSS](https://tailwindcss.com/)
29+
30+
## 🔒 Privacy Policy
31+
[Privacy Policy (for the extension only)](PRIVACY.md)
32+
33+
## 🔧 Development
34+
35+
### Clone the repository
36+
```bash
37+
git clone https://github.com/lcandy2/gitingest-extension.git
38+
```
39+
40+
### Install dependencies
41+
```bash
42+
pnpm install
43+
```
44+
45+
### Run the development server
46+
```bash
47+
pnpm dev
48+
```
49+
50+
### Build the extension
51+
```bash
52+
pnpm build
53+
```
54+
55+
## 📄 License
56+
[MIT](LICENSE.md)

0 commit comments

Comments
 (0)