@diffpal/diffpal-darwin-arm64 0.1.1 → 0.1.2

package/README.md

@@ -1,75 +1,114 @@
 # DiffPal
 
-DiffPal is a diff-first, policy-aware review assistant.
+DiffPal reviews pull requests from the diff first, then publishes clear,
+policy-aware feedback back to your CI system.
 
-- Diff collection and review are treated as a first-class artifact (`findings.json`).
-- Review runs are mode-scoped: local review stays local, and host review emits only that host's artifacts.
-- GitHub is the primary host surface; GitLab and Azure adapters follow the same findings contract.
+It is built for teams that want AI review output that is easy to scan:
 
-## Package and runtime contract
+- a PR summary with reviewed files and pass/fail status
+- inline comments only for actionable findings
+- merge gating through checks/statuses, not bot approvals
+- one config file that works across GitHub, GitLab, and Azure DevOps
 
-- Go module: `github.com/diffpal/diffpal`
-- CLI binary: `diffpal`
-- Default package license: `MIT`
-- Build stack: Go 1.26.4
-- CLI package: `@diffpal/diffpal`
-- GitHub Action: `diffpal/action`
-- NPM scope: `@diffpal/*`
-- Self-review: `.github/workflows/diffpal-review.yml` installs `@diffpal/diffpal@latest` and runs this repository's action on same-repository pull requests.
+## Quick Start
 
-See [docs/product-contract.md](docs/product-contract.md) for full contract details.
+Install the CLI and Copilot provider:
 
-## Commands
+```bash
+npm install --global @diffpal/diffpal@latest @github/copilot@latest
+diffpal init
+diffpal doctor
+```
 
-This repository includes the canonical CLI command tree:
+Then add DiffPal to your CI:
 
-- `diffpal review`
-- `diffpal review local`
-- `diffpal review github`
-- `diffpal review gitlab`
-- `diffpal review ado`
-- `diffpal sarif`
-- `diffpal init`
-- `diffpal doctor`
-- `diffpal version`
+- [GitHub Actions setup](docs/ci-examples.md#github-actions)
+- [GitLab CI setup](docs/ci-examples.md#gitlab-ci)
+- [Azure Pipelines setup](docs/ci-examples.md#azure-pipelines)
 
-## Repository layout
+For production, pin `@diffpal/diffpal` and `@github/copilot` to tested SemVer
+versions instead of using `@latest`.
 
-- `cmd/diffpal` contains the build entrypoint for the CLI binary.
-- `internal/cmd` contains the Cobra command tree and command wiring.
-- `internal/...` contains non-exported runtime, diff, policy, findings, platform, and reliability packages.
-- `docs/` records the product contract, config, platform adapters, and release behavior.
+## What DiffPal Publishes
 
-## Documentation
+On pull requests, DiffPal can publish:
 
-- [Quickstart](docs/quickstart.md)
-- [Config and policy reference](docs/config-reference.md)
-- [Configuration schema](docs/config-schema.md)
-- [Findings schema](docs/findings-schema.md)
-- [GitHub/GitLab/Azure CI examples](docs/ci-examples.md)
-- [GitLab adapter contract](docs/platform-gitlab.md)
-- [Azure adapter contract](docs/platform-azure.md)
-- [Release process](docs/release.md)
+- a review summary comment
+- a required check/status for merge gating
+- inline comments or threads for actionable findings
+- JSON, SARIF, and CI artifacts for later inspection
+
+The default review checks are:
+
+- `bugs`
+- `performance`
+- `best-practices`
+
+The default review language is English. Both are configurable in
+`.config/diffpal/config.yaml` or by CLI flags.
+
+## Minimal Config
+
+`diffpal init` writes `.config/diffpal/config.yaml`. The default public
+onboarding provider is Copilot ACP:
+
+```yaml
+version: v1
+
+defaults:
+  provider: copilot-acp
+  policy: default
 
-## First Commands
+providers:
+  copilot-acp:
+    type: copilot_acp
+    copilot_acp:
+      extra_args:
+        - --stdio
+
+policies:
+  default:
+    block_on: high
+
+review:
+  context_lines: 20
+  max_files: 200
+  language: en
+  checks:
+    - bugs
+    - performance
+    - best-practices
+```
+
+## Common Commands
 
 ```bash
-diffpal init
-diffpal doctor
+diffpal doctor --mode github
 diffpal review local --base origin/main --head HEAD
-diffpal review github --base origin/main --head HEAD --gate
+diffpal review github --base "$BASE_SHA" --head "$HEAD_SHA" --feedback balanced --gate
+diffpal review gitlab --base "$BASE_SHA" --head "$HEAD_SHA" --feedback balanced --gate
+diffpal review ado --base "$BASE_SHA" --head "$HEAD_SHA" --feedback balanced --gate
 ```
 
+## Documentation
+
+- [Quickstart](docs/quickstart.md)
+- [CI setup guide](docs/ci-examples.md)
+- [Config reference](docs/config-reference.md)
+- [Findings schema](docs/findings-schema.md)
+- [GitLab adapter reference](docs/platform-gitlab.md)
+- [Azure adapter reference](docs/platform-azure.md)
+- [Release process](docs/release.md)
+
 ## Development
 
+Source development in this repository uses the Go toolchain directly:
+
 ```bash
 go mod download
-go mod verify
 go test ./...
-go tool golangci-lint run ./...
 go run ./cmd/diffpal --help
 ```
 
-The npm package is the user-facing CLI distribution. Source development in this repository uses the Go toolchain directly.
-
-Maintainers track project work in Beads (`bd`). External contributors do not need Beads to open issues or pull requests.
+Maintainers track project work in Beads (`bd`). External contributors do not
+need Beads to open issues or pull requests.

package/package.json

@@ -16,5 +16,5 @@
   "os": [
     "darwin"
   ],
-  "version": "0.1.1"
+  "version": "0.1.2"
 }