mirror of
https://github.com/yamadashy/repomix.git
synced 2025-06-11 00:25:54 +03:00
feat(browser): Add .gitignore and README.md for Repomix extension
This commit is contained in:
48
browser/.gitignore
vendored
Normal file
48
browser/.gitignore
vendored
Normal file
@@ -0,0 +1,48 @@
|
||||
# Dependencies
|
||||
node_modules/
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# Build output
|
||||
dist/
|
||||
packages/
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
# OS generated files
|
||||
.DS_Store
|
||||
.DS_Store?
|
||||
._*
|
||||
.Spotlight-V100
|
||||
.Trashes
|
||||
ehthumbs.db
|
||||
Thumbs.db
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage/
|
||||
|
||||
# Temporary folders
|
||||
tmp/
|
||||
temp/
|
||||
90
browser/README.md
Normal file
90
browser/README.md
Normal file
@@ -0,0 +1,90 @@
|
||||
# Repomix
|
||||
|
||||
A browser extension that adds a Repomix button to GitHub repository pages.
|
||||
|
||||

|
||||
|
||||
## 🚀 Features
|
||||
|
||||
- Adds a "Repomix" button to GitHub repository pages
|
||||
- One-click redirect to Repomix (https://repomix.com)
|
||||
- Seamlessly integrates with GitHub's UI design
|
||||
- Works on Chrome, Firefox, and Edge
|
||||
|
||||
## 🛠️ Usage
|
||||
|
||||
1. Install the browser extension
|
||||
2. Navigate to any GitHub repository page
|
||||
3. A "Repomix" button will appear in the page header action area
|
||||
4. Click the button to open the repository in Repomix
|
||||
|
||||
## 💻 Development
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js 22 or higher
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Generate icons
|
||||
npm run generate-icons
|
||||
|
||||
# Development mode for Chrome
|
||||
npm run dev chrome
|
||||
|
||||
# Development mode for Firefox
|
||||
npm run dev firefox
|
||||
|
||||
# Development mode for Edge
|
||||
npm run dev edge
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
# Build for all browsers
|
||||
npm run build-all
|
||||
|
||||
# Build for specific browsers
|
||||
npm run build chrome
|
||||
npm run build firefox
|
||||
npm run build edge
|
||||
```
|
||||
|
||||
Built files will be generated in the `dist/` folder.
|
||||
|
||||
### Manual Installation
|
||||
|
||||
1. Run `npm run build chrome` to build
|
||||
2. Open `chrome://extensions/` in Chrome
|
||||
3. Enable "Developer mode"
|
||||
4. Click "Load unpacked extension"
|
||||
5. Select the `dist/chrome` folder
|
||||
|
||||
## 📝 Technical Specifications
|
||||
|
||||
- **Manifest V3** - Latest browser extension specification
|
||||
- **Content Scripts** - Direct button injection into GitHub pages
|
||||
- **Internationalization** - English and Japanese support
|
||||
- **Cross-browser** - Chrome, Firefox, Edge support
|
||||
|
||||
## 🔒 Privacy
|
||||
|
||||
This extension:
|
||||
- Does not collect any data
|
||||
- Does not track user behavior
|
||||
- Only accesses github.com
|
||||
- Requires minimal permissions
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT License
|
||||
|
||||
## 🙋♂️ Related Projects
|
||||
|
||||
- [Repomix](https://github.com/yamadashy/repomix) - AI-friendly repository packing tool
|
||||
- [Repomix Website](https://repomix.com) - Online version of Repomix
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "GitHub Repomix Button (Unofficial)",
|
||||
"short_name": "gh-repomix",
|
||||
"name": "Repomix",
|
||||
"short_name": "repomix",
|
||||
"version": "1.0.0",
|
||||
"manifest_version": 3,
|
||||
"description": "__MSG_appDescription__",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"private": true,
|
||||
"name": "github-repomix-button",
|
||||
"name": "repomix",
|
||||
"version": "1.0.0",
|
||||
"description": "A browser extension that adds a Repomix button to GitHub repositories",
|
||||
"scripts": {
|
||||
|
||||
Reference in New Issue
Block a user