Skip to content

Commit 616f8cc

Browse files
sarth6claude
andcommitted
Refresh README: train icon as banner, sidebar architecture
- Center the train icon at 96px as a hero/banner image with a descriptive alt ("steam locomotive on a dark GitHub-themed card") instead of the misleading "screenshot placeholder" alt text. - Update the architecture section to mention the sidebar widget placement and credit Refined GitHub for the selector strategy. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent c324330 commit 616f8cc

1 file changed

Lines changed: 19 additions & 12 deletions

File tree

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# GitHub Conductor
1+
<p align="center">
2+
<img src="public/icons/icon-128.png" alt="GitHub Conductor icon — a steam locomotive on a dark GitHub-themed card" width="96" height="96" />
3+
</p>
24

3-
> One click from any GitHub PR to a Conductor workspace with your prompt
4-
> already running.
5+
<h1 align="center">GitHub Conductor</h1>
56

6-
A lightweight Chrome extension that injects a button on every GitHub Pull
7-
Request page. Click it and your configured prompt — populated with the PR's
8-
metadata — opens in a fresh [Conductor](https://conductor.build) workspace via
9-
the `conductor://` deep link.
7+
<p align="center">
8+
One click from any GitHub PR to a <a href="https://conductor.build">Conductor</a>
9+
workspace with your prompt already running.
10+
</p>
1011

11-
![screenshot placeholder](public/icons/icon-128.png)
12+
A lightweight Chrome extension that adds a **Conductor** section to every
13+
GitHub Pull Request's right sidebar — directly above _Reviewers_. Click the
14+
button and your configured prompt, populated with the PR's metadata, opens
15+
in a fresh Conductor workspace via the `conductor://` deep link.
1216

1317
## Why
1418

@@ -89,20 +93,23 @@ GitHub button runs. All presets are accessible from the toolbar popup.
8993

9094
## Architecture
9195

92-
Five small, separately testable modules:
93-
9496
```
9597
src/
9698
├── types.ts ← shared TypeScript types
9799
├── storage.ts ← chrome.storage.sync adapter + in-memory fallback
98100
├── template.ts ← {placeholder} substitution engine
99101
├── conductor-url.ts ← builds conductor:// URLs with safe encoding
100102
├── pr-scraper.ts ← extracts PR metadata from the DOM
101-
├── content/ ← content script: button injection on PR pages
102-
├── options/ ← settings page
103+
├── content/ ← content script: sidebar widget above Reviewers
104+
├── options/ ← settings page (manage presets, URL template)
103105
└── popup/ ← toolbar popup with preset list
104106
```
105107

108+
The widget injects above `#reviewers-select-menu` in GitHub's PR sidebar —
109+
a stable selector from GitHub's Rails partial that's been around for years
110+
(the same anchor [Refined GitHub](https://github.com/refined-github/refined-github)
111+
uses). Three-tier fallback: reviewers → sidebar top → PR header.
112+
106113
Side effects live at the boundary (`storage`, `content`, `popup`). Everything
107114
else is pure functions, which is why **34 unit tests** run in under a second.
108115

0 commit comments

Comments
 (0)