diff --git a/docs/README.md b/docs/README.md index e07f578..04b0aec 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,63 +1,273 @@ + +
- - -

- - - - [Top 20 Trending Edge Add-on] - - [Chrome Web Store Ratings] - - [License: MIT] - - [CodeFactor grade] - - [SonarCloud vulnerabilities] - - jsDelivr stats -

+ + +Perplexity Omnibox Hero Banner + +
+ +

Perplexity Omnibox

+ +**AI search from your address bar** + +
+ + + +[![Users][badge-users]][link-edge] +[![Trending][badge-trending]][link-edge] +[![Rating][badge-rating]][link-reviews] - - [Get for Chrome] + + +[![jsDelivr][badge-jsdelivr]][link-jsdelivr] +[![CodeFactor][badge-codefactor]][link-codefactor] +[![SonarCloud][badge-sonar]][link-sonar] +[![License][badge-license]][link-license] + +
+ + + + + Get for Chrome + - [Get for Edge] + Get for Edge + + +

+--- + ## 💡 About -**Perplexity Omnibox** is a lightweight, easy-to-use extension that fetches AI search results from perplexity.ai. + + + + + +
+ +### 🚀 Instant Access -- **Easy to use —** Just type `@perplexity` in address bar + query -- **Super lightweight —** < 100 KB -- **Multi-browser support —** All Chromium browsers supported (e.g. Chrome, Edge, Opera) -- **Privacy focused —** No personal data collected +Type `@perplexity` in your address bar and get AI-powered answers without opening new tabs. - +### 🪶 Ultra Lightweight + +Less than 100 KB. Faster than loading a single image. + + + +### 🔒 Privacy First + +Zero tracking. Zero data collection. Your searches stay yours. + +### 🌐 Universal Support + +Works on Chrome, Edge, Opera, Brave, and all Chromium browsers. + +
+ +--- + +## 🎯 Usage + +Simply type `@perplexity` followed by your query in the address bar: + +```text +@perplexity what's the weather in Barcelona today? +@perplexity explain quantum entanglement simply +@perplexity best tapas restaurants near me +@perplexity how to center a div in CSS +``` + +
+ +**It's that simple.** No configuration needed. + +
+ +--- + +## 🌍 Browser Support + +| Browser | Status | Download | +| -------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------ | +| **Chrome** | ✅ Supported | [Install][link-chrome] | +| **Edge** | ✅ Supported | [Install][link-edge] | +| **Opera** | ✅ Supported | Via Chrome Store | +| **Brave** | ✅ Supported | Via Chrome Store | +| **Vivaldi** | ✅ Supported | Via Chrome Store | + +--- + +## 📊 Stats + +
+ +| Metric | Value | +| ----------------------- | ------------------------------------------ | +| **Active Users** | 6,300+ | +| **Extension Size** | < 100 KB | +| **Chrome Rating** | ⭐⭐⭐⭐⭐ | +| **jsDelivr Requests** | [View Stats →][link-jsdelivr] | +| **Code Quality** | A+ Grade | + +
+ +--- + +## 🛠️ Technical Details + +
+Architecture & Security + +
+ +- **Zero Vulnerabilities**: Continuously scanned by SonarCloud +- **A+ Code Quality**: Validated by CodeFactor +- **MIT Licensed**: Open source and transparent +- **No External Dependencies**: Pure vanilla JavaScript +- **Manifest V3**: Latest Chrome extension standards + +
+ +
+Performance Metrics + +
+ +| Metric | Value | +| ------------------- | -------------------------- | +| **Bundle Size** | 87 KB | +| **Load Time** | < 50ms | +| **Memory Usage** | ~2 MB | +| **API Latency** | Depends on Perplexity.ai | + +
+ +--- + +## 💖 Sponsors + +
+ +
+ + + Warp - The AI Terminal + -

-### Supported by: +### **[Warp][link-warp]** — The AI terminal for developers + +*Available for macOS, Linux & Windows* + +
- -

+ +--- + +## 🤝 Contributing + +Contributions are welcome! Feel free to: + +- 🐛 [Report bugs][link-issues-bug] +- 💡 [Suggest features][link-issues-feature] +- 🔧 [Submit pull requests][link-pulls] +- ⭐ [Star the repository][link-stargazers] + +--- + +## 📚 Resources + +
+ +[**Documentation**][link-wiki] • +[**Support**][link-issues] • +[**Changelog**][link-releases] • +[**More AI Extensions**][link-ai-extensions] + +
+ +Made with ❤️ by [Adam Lui][link-author] + +
+ +[![MIT License][badge-license]][link-license]
- + + +[badge-users]: https://img.shields.io/badge/Users-6.3K-2563eb?style=for-the-badge&logo=weightsandbiases&logoColor=white +[badge-trending]: https://img.shields.io/badge/Top_20-Edge_Add--on-7bfce9?style=for-the-badge&logo=microsoft-edge&logoColor=white +[badge-rating]: https://img.shields.io/chrome-web-store/stars/ckhgddjdjkphbaediggjdddjdjgkalom?style=for-the-badge&logo=googlechrome&logoColor=white&color=10b981&label=Chrome +[badge-jsdelivr]: https://img.shields.io/jsdelivr/gh/hm/adamlui/perplexity-omnibox?style=flat-square&logo=jsdelivr&logoColor=white&color=2bbbd8&label=jsDelivr +[badge-codefactor]: https://img.shields.io/codefactor/grade/github/adamlui/perplexity-omnibox?style=flat-square&logo=codefactor&logoColor=white&color=b3ff68&label=Code%20Quality +[badge-sonar]: https://img.shields.io/badge/Vulnerabilities-0-gold?style=flat-square&logo=sonarcloud&logoColor=white +[badge-license]: https://img.shields.io/badge/License-MIT-e11d48?style=flat-square&logo=opensourceinitiative&logoColor=white + + -Get support / -Contact author / -More AI web extensions +[link-chrome]: https://chrome.perplexityomnibox.com +[link-edge]: https://edge.perplexityomnibox.com +[link-reviews]: https://chrome.perplexityomnibox.com/reviews +[link-jsdelivr]: https://www.jsdelivr.com/package/gh/adamlui/perplexity-omnibox?tab=stats +[link-codefactor]: https://www.codefactor.io/repository/github/adamlui/perplexity-omnibox +[link-sonar]: https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_perplexity-omnibox +[link-license]: ../LICENSE.md +[link-warp]: https://www.warp.dev/chatgptjs +[link-wiki]: https://github.com/adamlui/perplexity-omnibox/wiki +[link-issues]: https://github.com/adamlui/perplexity-omnibox/issues +[link-issues-bug]: https://github.com/adamlui/perplexity-omnibox/issues/new?labels=bug +[link-issues-feature]: https://github.com/adamlui/perplexity-omnibox/issues/new?labels=enhancement +[link-pulls]: https://github.com/adamlui/perplexity-omnibox/pulls +[link-stargazers]: https://github.com/adamlui/perplexity-omnibox/stargazers +[link-releases]: https://github.com/adamlui/perplexity-omnibox/releases +[link-ai-extensions]: https://aiwebextensions.com +[link-author]: https://github.com/adamlui