Skip to content

docs(readme): a README that shows Botloft - #47

Merged
httpsphl merged 1 commit into
mainfrom
docs/readme
Sep 30, 2026
Merged

httpsphl merged 1 commit into
mainfrom
docs/readme

Conversation

@httpsphl

Copy link
Copy Markdown
Owner

What

The README said little and showed nothing. This one:

  • Top: the animated mascot, the name and one line, then badges (release, CI, Windows 10 and 11, license) and links to download, features, how it works and the FAQ. The mascot is docs/assets/mascot.svg, built from the app's own art and idle frames (flame, blink, glance), and it stays still under reduced motion.
  • Hero screenshot of a crew, in the reader's light or dark theme (<picture>).
  • What you can do: the crew Chief, chat with requests, work handed between bots, the live browser with the owner taking control, screens, routines, running in the background, and choices per bot. Four captioned screenshots: chat and browser, screens, Chief, routines.
  • Get started (requirements and the SmartScreen step), How it works (a Mermaid diagram and the principles), Privacy and security, a FAQ (cost, the window, where files live, the Windows warning, macOS and Linux, and that Botloft is independent from Anthropic), and Status in place of the milestone table. Development moves into a folded section.

Every claim was checked against the code and spec 7.4, 14, 15, 20, 21 and 22.

Images

The screenshots come from the dev preview's sample crews (pnpm dev), captured at 1800 px with a headless Edge. The "1 not delivered" notice from the sample data is hidden in them. They add about 1.7 MB in docs/assets/.

Merge with 0.6.0

The browser, screens, tray icon and notifications are in main but not in 0.5.0. This PR should merge together with the 0.6.0 release, so the README never describes features the latest download lacks. Auto-merge is off on purpose.

Checked

Rendered through GitHub's own Markdown API (repository mode), in dark and light, with the Mermaid diagram drawn.

…shots

The README said little and showed nothing. Now it opens with the animated
mascot (an SVG built from the app's own art and idle frames, still under
reduced motion), badges and a download link, then a hero screenshot that
follows the reader's light or dark theme.

It covers what Botloft does today (the crew Chief, chat with requests,
work handed between bots, the live browser, screens, routines, running in
the background, choices per bot) with four captioned screenshots; getting
started; how it works, with a diagram; privacy and security; a FAQ that
also says Botloft is independent from Anthropic; and a current status in
place of the milestone table. Development moves into a folded section.

The screenshots come from the dev preview's sample crews, not real data.
@httpsphl
httpsphl merged commit 430fdfb into main Sep 30, 2026
3 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