@brainwav/diagram 1.0.1 → 1.0.3

package/README.md

@@ -4,8 +4,11 @@ Generate codebase architecture diagrams from source files. No AI required.
 
 ## Table of Contents
 
+- [Upgrade notice](#upgrade-notice)
+- [Plain-language summary](#plain-language-summary)
 - [Install](#install)
 - [Quick start](#quick-start)
+- [First-run checklist](#first-run-checklist)
 - [Commands](#commands)
 - [Diagram types](#diagram-types)
 - [Output formats](#output-formats)
@@ -15,6 +18,27 @@ Generate codebase architecture diagrams from source files. No AI required.
 - [Development](#development)
 - [License](#license)
 
+## Upgrade notice
+
+⚠️ `@brainwav/diagram@1.0.0` had a packaging regression and failed at runtime with
+`Cannot find module './utils/commands'`. Please use
+`@brainwav/diagram@1.0.1` or later.
+
+## Plain-language summary
+
+This tool reads code and draws a map.
+You point it at a repo.
+It scans files.
+It finds links.
+It prints a clear graph.
+You can save that graph.
+You can save PNG or SVG files.
+You can make short video clips.
+You can test code layer rules.
+You can run it on your laptop.
+You can run it in CI.
+The goal is simple: keep the code map clear and keep rule drift low.
+
 ## Install
 
 ```bash
@@ -38,6 +62,27 @@ diagram generate .
 diagram all .
 ```
 
+## First-run checklist
+
+Use a small test repo first.
+Run from the repo root.
+Start with `diagram analyze .`.
+Read the file and link count.
+Next, run `diagram generate .`.
+Save one file with `--output`.
+Pick `.mmd` for text output.
+Pick `.svg` for image output.
+Use `diagram all .` for all views.
+Use `--max-files` if runs are slow.
+Keep path globs short and clear.
+Skip build and vendored dirs.
+Try `diagram test --init` for rules.
+Then run `diagram test` to check rules.
+Use `--dry-run` when match sets look odd.
+Use `--verbose` if you need more detail.
+Run `npm test` to check local health.
+Run `npm run test:deep` for deep checks.
+
 ## Commands
 
 ### `diagram analyze [path]`
@@ -268,17 +313,24 @@ jobs:
       - run: npm ci
       - run: npm test
       - run: npm run test:deep
-      - run: node src/diagram.js test . --format junit --output architecture-results.xml
+      - run: npm run ci:artifacts
+      - uses: actions/upload-artifact@v4
+        with:
+          name: diagram-ci-artifacts
+          path: .diagram
       - uses: dorny/test-reporter@v1
         if: success() || failure()
         with:
           name: Architecture Tests
-          path: architecture-results.xml
+          path: .diagram/architecture-results.xml
           reporter: java-junit
 ```
 
 ## Documentation
 
+- Getting started: [docs/getting-started.md](docs/getting-started.md)
+- Architecture testing guide: [docs/architecture-testing.md](docs/architecture-testing.md)
+- Migration guide: [docs/migration-from-dependency-cruiser.md](docs/migration-from-dependency-cruiser.md)
 - Contributor guide: [CONTRIBUTING.md](CONTRIBUTING.md)
 - Security policy: [SECURITY.md](SECURITY.md)
 - Support policy: [SUPPORT.md](SUPPORT.md)
@@ -286,6 +338,10 @@ jobs:
 - Maintainer docs index: [docs/README.md](docs/README.md)
 - Release history: [CHANGELOG.md](CHANGELOG.md)
 
+## Documentation signature
+
+brAInwav - from demo to duty
+
 ## Development
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brainwav/diagram",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Generate architecture diagrams from codebases",
   "main": "src/diagram.js",
   "bin": {
@@ -9,6 +9,7 @@
   "scripts": {
     "test": "node src/diagram.js analyze .",
     "test:deep": "node scripts/deep-regression.js",
+    "ci:artifacts": "mkdir -p .diagram && node src/diagram.js all . --output-dir .diagram && node src/diagram.js test . --format junit --output .diagram/architecture-results.xml",
     "prepublishOnly": "npm test",
     "release:prepare": "bash scripts/release-npm.sh",
     "release:prepare:initial": "bash scripts/release-npm.sh --initial",