Skip to content

Commit d35f510

Browse files
committed
docs: enhance README with badges, security info, and updated links
- Add CI and SDK Kit badges - Fix GitHub username (yourusername → prosdevlab) - Add Security & Privacy section - Add Support section Closes #8
1 parent 9838d68 commit d35f510

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
A Chrome extension that automatically injects authentication headers into HTTP requests based on URL patterns. Built for developers who need to test APIs with different auth tokens across multiple environments.
44

5+
[![CI](https://github.com/prosdevlab/auth-header-injector/actions/workflows/ci.yml/badge.svg)](https://github.com/prosdevlab/auth-header-injector/actions/workflows/ci.yml)
56
![Chrome Version](https://img.shields.io/badge/chrome-v114+-blue)
67
![License](https://img.shields.io/badge/license-MIT-green)
8+
[![SDK Kit](https://img.shields.io/badge/built_with-SDK_Kit-purple)](https://github.com/lytics/sdk-kit)
79

810
## Features
911

@@ -16,11 +18,17 @@ A Chrome extension that automatically injects authentication headers into HTTP r
1618

1719
## Installation
1820

21+
### From Chrome Web Store
22+
23+
> 🚀 **Coming Soon** - Extension is currently in review for Chrome Web Store
24+
25+
Once published, you'll be able to install directly from the Chrome Web Store.
26+
1927
### From Source
2028

2129
1. **Clone the repository**
2230
```bash
23-
git clone https://github.com/yourusername/auth-header-injector.git
31+
git clone https://github.com/prosdevlab/auth-header-injector.git
2432
cd auth-header-injector
2533
```
2634

@@ -184,6 +192,33 @@ src/
184192
-**Request debouncing** - Duplicate requests ignored for 1s
185193
-**Event-driven UI** - Updates via `chrome.storage.onChanged`, no polling
186194

195+
## Security & Privacy
196+
197+
### Data Storage
198+
199+
- **All data is stored locally** on your device using Chrome's sync storage
200+
- **No external servers** - No data is transmitted to any third-party services
201+
- **No analytics or tracking** - We don't collect any usage data
202+
- **Open source** - Full code transparency for security auditing
203+
204+
### Token Security
205+
206+
- Tokens are stored in Chrome's encrypted sync storage
207+
- Never logged or transmitted except to your configured domains
208+
- Visible only when you explicitly choose to show them
209+
- Synced securely across your Chrome instances (if Chrome sync is enabled)
210+
211+
### Permissions Explained
212+
213+
We require these permissions for core functionality:
214+
215+
- `declarativeNetRequest` - Inject authentication headers into matching requests
216+
- `storage` - Store your rules and tokens locally
217+
- `tabs` - Detect current page URL for context-aware UI
218+
- `sidePanel` - Display the extension interface
219+
- `webRequest` - Track request statistics (counts only, no content)
220+
- `host_permissions (<all_urls>)` - Allow header injection on domains you configure
221+
187222
## API & Permissions
188223

189224
### Required Permissions
@@ -377,9 +412,15 @@ We use [Conventional Commits](https://www.conventionalcommits.org/):
377412

378413
MIT License - see [LICENSE](LICENSE) for details
379414

415+
## Support
416+
417+
- **Issues:** [GitHub Issues](https://github.com/prosdevlab/auth-header-injector/issues)
418+
- **Discussions:** [GitHub Discussions](https://github.com/prosdevlab/auth-header-injector/discussions)
419+
- **Repository:** [github.com/prosdevlab/auth-header-injector](https://github.com/prosdevlab/auth-header-injector)
420+
380421
## Acknowledgments
381422

382-
- [SDK Kit](https://github.com/yourusername/sdk-kit) - Plugin architecture
423+
- [SDK Kit](https://github.com/lytics/sdk-kit) - Plugin architecture for Chrome extensions
383424
- [Shadcn UI](https://ui.shadcn.com/) - Component library
384425
- [Lucide Icons](https://lucide.dev/) - Icon set
385426
- [Chrome Extensions Docs](https://developer.chrome.com/docs/extensions/) - API reference
@@ -388,3 +429,5 @@ MIT License - see [LICENSE](LICENSE) for details
388429

389430
**Built with ❤️ for developers who live in the browser**
390431

432+
**Free & Open Source** • MIT License • [ProsDevLab](https://github.com/prosdevlab)
433+

0 commit comments

Comments
 (0)