truecourse 0.6.8 → 0.6.10

package/README.md

@@ -7,7 +7,7 @@
 </p>
 
 <p align="center">
-  <em>1,200+ deterministic rules, 100 LLM rules. JavaScript, TypeScript, Python.</em>
+  <em>1,500+ deterministic rules, 100 LLM rules. JavaScript, TypeScript, Python, C#.</em>
 </p>
 
 <p align="center">
@@ -28,12 +28,24 @@ Both store their results under `.truecourse/` and surface them in a shared [dash
   <img src="assets/demo.gif" alt="TrueCourse Screenshot" width="100%" />
 </p>
 
-Jump to: **[1. Analyze](#1-analyze--code-intelligence)** · **[2. Spec → Verify](#2-spec--verify--business-logic-drift)** · **[Dashboard](#dashboard-web-ui)**
+Jump to: **[Install](#install)** · **[1. Analyze](#1-analyze--code-intelligence)** · **[2. Spec → Verify](#2-spec--verify--business-logic-drift)** · **[Dashboard](#dashboard-web-ui)**
 
 No setup step and no database: TrueCourse creates `.truecourse/` in your repo on first use and stores everything there as plain JSON files. It uses the [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) for LLM-powered work — if `claude` isn't on your PATH, deterministic analysis still runs and LLM-dependent features are skipped.
 
 ---
 
+# Install
+
+```bash
+npm install -g truecourse
+```
+
+This puts the `truecourse` command on your PATH — every example below uses it. Prefer not to install globally? Run any command one-off with `npx truecourse <command>` instead.
+
+See [Prerequisites](#prerequisites) for Node, Claude Code, and C# requirements.
+
+---
+
 # 1. Analyze — code intelligence
 
 Static + LLM analysis of your code: architecture, security, bugs, performance, and more.
@@ -42,8 +54,8 @@ Static + LLM analysis of your code: architecture, security, bugs, performance, a
 
 ```bash
 cd <your-repo>
-npx truecourse analyze      # Runs the full analysis in-process
-npx truecourse list         # Show the violations it found
+truecourse analyze          # Runs the full analysis in-process
+truecourse list             # Show the violations it found
 ```
 
 The first analyze creates `.truecourse/` and stores results as plain JSON. View them visually with [`truecourse dashboard`](#dashboard-web-ui).
@@ -315,15 +327,18 @@ The first `truecourse analyze` (or `truecourse add`) in a fresh repo asks whethe
 |---|---|
 | JavaScript / TypeScript | Supported |
 | Python | Supported |
-| C# | Planned |
+| C# | Supported * |
 | Go | Planned |
 | Rust | Planned |
 | PHP | Planned |
 
+\* Analyzing C# requires the .NET 8 SDK — its **semantic** rules run in a Roslyn host (build-required; analysis fails fast without it). See [Prerequisites](#prerequisites).
+
 ## Prerequisites
 
 - Node.js >= 20
 - [Claude Code](https://docs.anthropic.com/en/docs/claude-code) CLI on your PATH — optional. The default `cli` transport spawns it for LLM-powered work; deterministic rules and the `agent` transport (below) don't need it.
+- [.NET 8 SDK](https://dotnet.microsoft.com/download) — **required to analyze C#** (not needed for other languages). C#'s semantic rules run in a Roslyn host you build once (`dotnet build -c Release tools/csharp-roslyn-host`, or point `TRUECOURSE_ROSLYN_HOST` at a prebuilt binary). Analyzing a repo that contains C# without the host **fails fast** with a build-the-host message — there is deliberately no tree-sitter-only fallback, since a silent half-analysis is worse than a clear error.
 
 ## LLM transport (`--llm-transport`)