@docker-doctor/cli 0.2.1 → 0.3.1

package/README.md

@@ -28,13 +28,18 @@ Works with any project that uses Docker.
 npx @docker-doctor/cli@latest
 ```
 
-### 2. Browse rules
+### 2. Install for agents
+
+Once you have an audit, install the skill so your coding agent learns the `/docker-doctor` triage workflow and can fix the issues for you:
 
 ```bash
-npx @docker-doctor/cli@latest rules list
-npx @docker-doctor/cli@latest rules explain docker-doctor/no-root-user
+npx @docker-doctor/cli@latest install
 ```
 
+Works with Claude Code, Cursor, Codex, OpenCode, and many more. After an interactive scan finds issues, Docker Doctor also offers to hand them straight to an agent detected on your machine.
+
+[Rules reference →](https://docker-doctor.vercel.app/docs/reference/rules)
+
 ### 3. Run in CI
 
 Docker Doctor walks you through setting up a GitHub Actions workflow after your first scan:
@@ -45,15 +50,41 @@ npx @docker-doctor/cli@latest
 
 ### 4. Configure
 
-```js
+```ts
 // docker-doctor.config.ts
+import type { DockerDoctorConfig } from "@docker-doctor/cli";
+
 export default {
   rules: {
     "docker-doctor/no-root-user": "error",
   },
-};
+} satisfies DockerDoctorConfig;
+```
+
+Prefer YAML? `docker-doctor.config.yaml` works too, with editor autocomplete via `# yaml-language-server: $schema=https://docker-doctor.vercel.app/schema.json`. A `defineConfig` helper is also exported for projects with `@docker-doctor/cli` installed — see the [configuration docs](https://docker-doctor.vercel.app/docs/reference/configuration).
+
+## How the score works
+
+Every scan produces a 0-100 health score alongside a label (`Excellent 🏆`, `Good ✅`, `Needs Work ⚠️`, `Critical 🚨`).
+
+Each diagnostic adds a penalty based on severity:
+
+| Severity  | Penalty |
+| --------- | ------- |
+| `error`   | 10      |
+| `warning` | 4       |
+| `info`    | 1       |
+
+The penalties are summed, then the score is computed as an asymptotic decay curve rather than a simple subtraction:
+
+```
+score = round(100 * e^(-penalty / K))   // K = 70
 ```
 
+A perfect project (no diagnostics) always scores exactly 100. As penalty increases, the score keeps decreasing — it approaches 0 but never gets stuck there, so the score stays meaningful (and can still register improvement) even on projects with a lot of findings. `K = 70` was chosen so a single warning (penalty 4) still lands around 94 — comfortably inside the `Excellent` bucket — while errors and repeated warnings continue to meaningfully erode the score.
+
+The label thresholds are unchanged: `>= 90` Excellent, `>= 75` Good, `>= 50` Needs Work, otherwise Critical.
+
 ## API
 
 ```ts