Skip to content

Point the README at the published docs site and 0.1.0 #1

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
rdlu merged 1 commit into from
Oct 17, 2026
Merged

Point the README at the published docs site and 0.1.0 #1

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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ cables, chargers and devices.

![The Charts tab: power and CPU with plug markers, each socket's link speed, URB/s and the chargers seen](docs/media/charts.png)

**Status: early development.** The report, health verdict, `--json`, the TUI,
recording and replay, `capture`, `labels` and the `--firmware` checks work.
**Status: 0.1.0, the first release.** Linux only; tested on a ThinkPad
(AMD) and a Dell XPS (Intel, Thunderbolt). Reports from other machines are
welcome.

The full documentation (reading the report, every health check, the TUI,
the keymap) is the docs site in `site/`, to be published at
<https://plugii.dlu.one/>; until then, `mise run docs` serves it
locally. This README is the short version.
the keymap) is at **<https://plugii.dlu.one/>**, built from `site/`
(`mise run docs` serves it locally). This README is the short version.

## Install

Expand Down