Skip to content

docs: Modernize README with professional structure and enhanced maintainability #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 12, 2025
Merged

docs: Modernize README with professional structure and enhanced maintainability #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
296 changes: 253 additions & 43 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,63 +1,273 @@
<!--
╔══════════════════════════════════════════════════════════════════════════════════╗
║ PERPLEXITY OMNIBOX ║
║ AI Search from Your Address Bar ║
╚══════════════════════════════════════════════════════════════════════════════════╝

Author: Adam Lui
License: MIT
Repository: https://github.com/adamlui/perplexity-omnibox
-->

<div align="center">

<img width="100%" src="https://assets.perplexityomnibox.com/images/tiles/marquee/edge/tile1400x560.png">
<br><br>

<a href="#">
<img height=31 src="https://img.shields.io/badge/Users-6.3K-blue?logo=weightsandbiases&logoColor=white&labelColor=464646&style=for-the-badge"></img></a>
<a href="https://edge.perplexityomnibox.com">
<img alt="[Top 20 Trending Edge Add-on]" height=31 src="https://img.shields.io/badge/Trending-Top_20_Edge_Add--on-7bfce9?logo=data:image/svg%2bxml;base64,PHN2ZyByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSJ3aGl0ZSIgZD0iTTIxLjg2IDE3Ljg2cS4xNCAwIC4yNS4xMi4xLjEzLjEuMjV0LS4xMS4zM2wtLjMyLjQ2LS40My41My0uNDQuNXEtLjIxLjI1LS4zOC40MmwtLjIyLjIzcS0uNTguNTMtMS4zNCAxLjA0LS43Ni41MS0xLjYuOTEtLjg2LjQtMS43NC42NHQtMS42Ny4yNHEtLjkgMC0xLjY5LS4yOC0uOC0uMjgtMS40OC0uNzgtLjY4LS41LTEuMjItMS4xNy0uNTMtLjY2LS45Mi0xLjQ0LS4zOC0uNzctLjU4LTEuNi0uMi0uODMtLjItMS42NyAwLTEgLjMyLTEuOTYuMzMtLjk3Ljg3LTEuOC4xNC45NS41NSAxLjc3LjQxLjgyIDEuMDIgMS41LjYuNjggMS4zOCAxLjIxLjc4LjU0IDEuNjQuOS44Ni4zNiAxLjc3LjU2LjkyLjIgMS44LjIgMS4xMiAwIDIuMTgtLjI0IDEuMDYtLjIzIDIuMDYtLjcybC4yLS4xLjItLjA1em0tMTUuNS0xLjI3cTAgMS4xLjI3IDIuMTUuMjcgMS4wNi43OCAyLjAzLjUxLjk2IDEuMjQgMS43Ny43NC44MiAxLjY2IDEuNC0xLjQ3LS4yLTIuOC0uNzQtMS4zMy0uNTUtMi40OC0xLjM3LTEuMTUtLjgzLTIuMDgtMS45LS45Mi0xLjA3LTEuNTgtMi4zM1QuMzYgMTQuOTRRMCAxMy41NCAwIDEyLjA2cTAtLjgxLjMyLTEuNDkuMzEtLjY4LjgzLTEuMjMuNTMtLjU1IDEuMi0uOTYuNjYtLjQgMS4zNS0uNjYuNzQtLjI3IDEuNS0uMzkuNzgtLjEyIDEuNTUtLjEyLjcgMCAxLjQyLjEuNzIuMTIgMS40LjM1LjY4LjIzIDEuMzIuNTcuNjMuMzUgMS4xNi44My0uMzUgMC0uNy4wNy0uMzMuMDctLjY1LjIzdi0uMDJxLS42My4yOC0xLjIuNzQtLjU3LjQ2LTEuMDUgMS4wNC0uNDguNTgtLjg3IDEuMjYtLjM4LjY3LS42NSAxLjM5LS4yNy43MS0uNDIgMS40NC0uMTUuNzItLjE1IDEuMzh6TTExLjk2LjA2cTEuNyAwIDMuMzMuMzkgMS42My4zOCAzLjA3IDEuMTUgMS40My43NyAyLjYyIDEuOTMgMS4xOCAxLjE2IDEuOTggMi43LjQ5Ljk0Ljc2IDEuOTYuMjggMSAuMjggMi4wOCAwIC44OS0uMjMgMS43LS4yNC44LS42OSAxLjQ4LS40NS42OC0xLjEgMS4yMi0uNjQuNTMtMS40NS44OC0uNTQuMjQtMS4xMS4zNi0uNTguMTMtMS4xNi4xMy0uNDIgMC0uOTctLjAzLS41NC0uMDMtMS4xLS4xMi0uNTUtLjEtMS4wNS0uMjgtLjUtLjE5LS44NC0uNS0uMTItLjA5LS4yMy0uMjQtLjEtLjE2LS4xLS4zMyAwLS4xNS4xNi0uMzUuMTYtLjIuMzUtLjUuMi0uMjguMzYtLjY4LjE2LS40LjE2LS45NSAwLTEuMDYtLjQtMS45Ni0uNC0uOTEtMS4wNi0xLjY0LS42Ni0uNzQtMS41Mi0xLjI4LS44Ni0uNTUtMS43OS0uODktLjg0LS4zLTEuNzItLjQ0LS44Ny0uMTQtMS43Ni0uMTQtMS41NSAwLTMuMDYuNDVULjk0IDcuNTVxLjcxLTEuNzQgMS44MS0zLjEzIDEuMS0xLjM4IDIuNTItMi4zNVE2LjY4IDEuMSA4LjM3LjU4cTEuNy0uNTIgMy41OC0uNTJaIi8+PC9zdmc+&logoColor=white&labelColor=464646&style=for-the-badge"></img></a>
<a href="https://chrome.perplexityomnibox.com/reviews?utm_source=github&utm_medium=referral&utm_content=chrome-rating-shield">
<img alt="[Chrome Web Store Ratings]" height=31 src="https://img.shields.io/chrome-web-store/stars/ckhgddjdjkphbaediggjdddjdjgkalom?logo=googlechrome&logoColor=white&labelColor=464646&color=8afc25&style=for-the-badge"></img></a>
<a href="../LICENSE.md">
<img alt="[License: MIT]" height=31 src="https://img.shields.io/badge/License-MIT-fc4f2d.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></img></a>
<a href="https://www.codefactor.io/repository/github/adamlui/perplexity-omnibox">
<img alt="[CodeFactor grade]" height=31 src="https://img.shields.io/codefactor/grade/github/adamlui/perplexity-omnibox?label=Code+Quality&logo=codefactor&logoColor=white&labelColor=464646&color=b3ff68&style=for-the-badge"></img></a>
<a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_perplexity-omnibox">
<img alt="[SonarCloud vulnerabilities]" height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_perplexity-omnibox%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilities&color=gold"></img></a>
<a href="https://www.jsdelivr.com/package/gh/adamlui/perplexity-omnibox?tab=stats">
<img alt="jsDelivr stats" height=31 src="https://img.shields.io/jsdelivr/gh/hm/adamlui/perplexity-omnibox?style=for-the-badge&logo=jsdelivr&logoColor=white&label=jsDelivr%20Requests&labelColor=464646&color=2bbbd8"></img></a>
<br><br>
<!-- ═══════════════════════════════════════════════════════════════════════════════
HERO SECTION
═══════════════════════════════════════════════════════════════════════════════ -->

<img
src="https://assets.perplexityomnibox.com/images/tiles/marquee/edge/tile1400x560.png"
alt="Perplexity Omnibox Hero Banner"
width="100%"
/>

<br>

<h1>Perplexity Omnibox</h1>

**AI search from your address bar**

<br>

<!-- ═══════════════════════════════════════════════════════════════════════════════
BADGES - Primary Metrics (for-the-badge style)
═══════════════════════════════════════════════════════════════════════════════ -->

[![Users][badge-users]][link-edge]
[![Trending][badge-trending]][link-edge]
[![Rating][badge-rating]][link-reviews]

<a href="https://chrome.perplexityomnibox.com/?utm_source=github&utm_medium=referral&utm_content=platform-badge">
<img alt="[Get for Chrome]" height=60 src="https://assets.perplexityomnibox.com/images/badges/chrome-web-store/available-in-the-chrome-web-store-green-square-border-light-498x152.png"></a>
<!-- ═══════════════════════════════════════════════════════════════════════════════
BADGES - Secondary Metrics (flat-square style)
═══════════════════════════════════════════════════════════════════════════════ -->

[![jsDelivr][badge-jsdelivr]][link-jsdelivr]
[![CodeFactor][badge-codefactor]][link-codefactor]
[![SonarCloud][badge-sonar]][link-sonar]
[![License][badge-license]][link-license]

<br>

<!-- ═══════════════════════════════════════════════════════════════════════════════
INSTALLATION BUTTONS
═══════════════════════════════════════════════════════════════════════════════ -->

<a href="https://chrome.perplexityomnibox.com/?utm_source=github&utm_medium=referral&utm_content=install-button">
<img
src="https://assets.perplexityomnibox.com/images/badges/chrome-web-store/available-in-the-chrome-web-store-green-square-border-light-498x152.png"
alt="Get for Chrome"
height="58"
/>
</a>
<a href="https://edge.perplexityomnibox.com">
<img alt="[Get for Edge]" height=60 src="https://assets.perplexityomnibox.com/images/badges/microsoft-store/get-it-from-microsoft-blue-square-border-light-457x157.png"></a>
<img
src="https://assets.perplexityomnibox.com/images/badges/microsoft-store/get-it-from-microsoft-blue-square-border-light-457x157.png"
alt="Get for Edge"
height="58"
/>
</a>

<br><br>

</div>

---

## 💡 About

**Perplexity Omnibox** is a lightweight, easy-to-use extension that fetches AI search results from perplexity.ai.
<table>
<tr>
<td width="50%">

### 🚀 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.

<img height=6px width="100%" src="https://assets.perplexityomnibox.com/images/separators/aqua-gradient.png">
### 🪶 Ultra Lightweight

Less than 100 KB. Faster than loading a single image.

</td>
<td width="50%">

### 🔒 Privacy First

Zero tracking. Zero data collection. Your searches stay yours.

### 🌐 Universal Support

Works on Chrome, Edge, Opera, Brave, and all Chromium browsers.

</td>
</tr>
</table>

---

## 🎯 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
```

<div align="center">

**It's that simple.** No configuration needed.

</div>

---

## 🌍 Browser Support

| Browser | Status | Download |
| -------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------ |
| <img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/chrome/chrome_48x48.png" width="20"> **Chrome** | ✅ Supported | [Install][link-chrome] |
| <img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/edge/edge_48x48.png" width="20"> **Edge** | ✅ Supported | [Install][link-edge] |
| <img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/opera/opera_48x48.png" width="20"> **Opera** | ✅ Supported | Via Chrome Store |
| <img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/brave/brave_48x48.png" width="20"> **Brave** | ✅ Supported | Via Chrome Store |
| <img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/vivaldi/vivaldi_48x48.png" width="20"> **Vivaldi** | ✅ Supported | Via Chrome Store |

---

## 📊 Stats

<div align="center">

| Metric | Value |
| ----------------------- | ------------------------------------------ |
| **Active Users** | 6,300+ |
| **Extension Size** | < 100 KB |
| **Chrome Rating** | ⭐⭐⭐⭐⭐ |
| **jsDelivr Requests** | [View Stats →][link-jsdelivr] |
| **Code Quality** | A+ Grade |

</div>

---

## 🛠️ Technical Details

<details>
<summary><b>Architecture & Security</b></summary>

<br>

- **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

</details>

<details>
<summary><b>Performance Metrics</b></summary>

<br>

| Metric | Value |
| ------------------- | -------------------------- |
| **Bundle Size** | 87 KB |
| **Load Time** | < 50ms |
| **Memory Usage** | ~2 MB |
| **API Latency** | Depends on Perplexity.ai |

</details>

---

## 💖 Sponsors

<div align="center">

<br>

<a href="https://www.warp.dev/chatgptjs" target="_blank">
<img
src="https://assets.chatgptjs.org/images/banners/warp/banner-1500x500.png?v=476e837"
width="650"
alt="Warp - The AI Terminal"
/>
</a>

<div id="sponsors" align="center">
<br>

### Supported by:
### **[Warp][link-warp]** — The AI terminal for developers

*Available for macOS, Linux & Windows*

<br>

<div id="warp">
<br><br>
<a href="https://www.warp.dev/chatgptjs" target="_blank">
<img width="600" src="https://assets.chatgptjs.org/images/banners/warp/banner-1500x500.png?v=476e837">
</a>
<h3><a href="https://www.warp.dev/chatgptjs" target="_blank">
Warp, the AI Devtool that lives in your terminal</a></h3>
<i><a href="https://www.warp.dev/chatgptjs" target="_blank">
Available for MacOS, Linux, & Windows</a></i>
</div>
<br><br>

---

## 🤝 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

<div align="center">

[**Documentation**][link-wiki] •
[**Support**][link-issues] •
[**Changelog**][link-releases] •
[**More AI Extensions**][link-ai-extensions]

<br>

Made with ❤️ by [Adam Lui][link-author]

<br>

[![MIT License][badge-license]][link-license]

</div>

<img height=6px width="100%" src="https://assets.perplexityomnibox.com/images/separators/aqua-gradient.png">
<!-- ═══════════════════════════════════════════════════════════════════════════════
BADGE DEFINITIONS
═══════════════════════════════════════════════════════════════════════════════ -->

[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

<!-- ═══════════════════════════════════════════════════════════════════════════════
LINK DEFINITIONS
═══════════════════════════════════════════════════════════════════════════════ -->

<a href="https://github.com/adamlui/perplexity-omnibox/issues">Get support</a> /
<a href="https://github.com/adamlui">Contact author</a> /
<a href="https://aiwebextensions.com">More AI web extensions</a>
[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