Skip to content

docs(readme): mention the VS Code extension under Quick start#21

Merged
1bcMax merged 1 commit intomainfrom
docs/vscode-extension-section
Apr 28, 2026
Merged

docs(readme): mention the VS Code extension under Quick start#21
1bcMax merged 1 commit intomainfrom
docs/vscode-extension-section

Conversation

@KillerQueen-Z
Copy link
Copy Markdown
Collaborator

Summary

The README's Quick start currently shows only the CLI install path. The same agent has shipped as a VS Code extension for a while, but new visitors landing on the GitHub page have no signal that a GUI version exists.

This adds a short subsection right after the CLI Quick start.

Diff

```md

Prefer a GUI? Try Franklin for VS Code

The same agent ships as a [VS Code extension] — chat panel, model
picker, wallet balance, image / video generation, inline diff cards
— all driven by the wallet you already funded for the CLI.

VS Code → Extensions (Cmd+Shift+X / Ctrl+Shift+X)
→ search "Franklin" → Install
→ click the Franklin icon in the Activity Bar

Free models work immediately. Paid models, image gen, and video gen
activate the moment your wallet has USDC. The CLI and the extension
share the same ~/.blockrun/ config and session history, so jumping
between terminal and VS Code is seamless.
```

Out of scope

  • No new top-level section, no new badges.
  • No reordering of existing content (pitch / YOPO / Smart Router etc. unchanged).
  • No bundled screenshots — kept text-only to match the rest of the Quick start.

```
README.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
```

The CLI install is the only entry point currently advertised on the
front page of the README, but the same agent has shipped as a VS Code
extension for a while now. New users coming from the GitHub page have
no signal that there's a GUI option.

This adds a short subsection right after the CLI Quick start with:
- Marketplace link
- Three-line install path (Extensions panel → search Franklin → click)
- A note that CLI and extension share ~/.blockrun/ state, so a wallet
  funded for one works for the other and session history carries over

Scope deliberately narrow — one block, no rearrangement of existing
content, no new badges, no separate top-level section. The pitch /
YOPO / Smart Router etc. stay intact.
@1bcMax 1bcMax merged commit fc665cf into main Apr 28, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant