@mcarvin/smart-diff 1.0.3 → 1.0.5

package/README.md

@@ -3,15 +3,14 @@
 [![NPM](https://img.shields.io/npm/v/@mcarvin/smart-diff.svg?label=smart-diff)](https://www.npmjs.com/package/@mcarvin/smart-diff)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/mcarvin8/smart-diff/main/LICENSE.md)
 [![Downloads/week](https://img.shields.io/npm/dw/@mcarvin/smart-diff.svg)](https://npmjs.org/package/@mcarvin/smart-diff)
+[![codecov](https://codecov.io/gh/mcarvin8/smart-diff/graph/badge.svg?token=H3ZWAGG7S9)](https://codecov.io/gh/mcarvin8/smart-diff)
 
 TypeScript library that turns a **git revision range** into a **Markdown summary** using an OpenAI-compatible Chat Completions API. It uses [`simple-git`](https://github.com/steveukx/git-js) to read the repo, respects **path includes/excludes** and **commit message include/exclude regexes**, and sends commits, paths, structured diff stats, and unified diff text to the model.
 
-There is **no local fallback**: you must either configure an LLM gateway via environment variables or pass `openAiClientProvider` (for tests or custom clients).
-
 ## Requirements
 
 - **Node.js** 20+
-- Git Bash
+- [Git Bash](https://git-scm.com/install/)
 
 ## Installation
 
@@ -19,8 +18,6 @@ There is **no local fallback**: you must either configure an LLM gateway via env
 npm install @mcarvin/smart-diff
 ```
 
-Build the package from source with `npm run build` (Rollup outputs CommonJS and ESM under `dist/`).
-
 ## LLM configuration
 
 The library is considered “configured” when `shouldUseLlmGateway()` is true: API key, base URL, and/or JSON default headers are set. Otherwise `summarizeGitDiff` / `generateSummary` throw with `LLM_GATEWAY_REQUIRED_MESSAGE` unless you pass **`openAiClientProvider`**.
@@ -35,6 +32,13 @@ The library is considered “configured” when `shouldUseLlmGateway()` is true:
 
 The client is created with the official [`openai`](https://www.npmjs.com/package/openai) SDK via `createOpenAiLikeClient()`; use a compatible endpoint and model ID for your provider.
 
+Example using a company-managed OpenAI-compatible gateway:
+
+```powershell
+$env:LLM_DEFAULT_HEADERS = '{"x-company-rbac":"your-rbac-token-here","Authorization":"sk-your-api-key-here"}'
+$env:LLM_BASE_URL = "https://llm-gateway.example.com"
+```
+
 ## Usage
 
 ### `summarizeGitDiff`
@@ -80,12 +84,11 @@ const markdown = await summarizeGitDiff({
 
 The package also exports helpers such as `createGitClient`, `getCommits`, `getDiff`, `getDiffSummary`, `getChangedFiles`, `filterCommitsByMessageRegexes`, `buildDiffPathspecs`, `generateSummary`, and OpenAI config utilities (`resolveLlmBaseUrl`, `shouldUseLlmGateway`, `createOpenAiLikeClient`, …). Use these if you build a custom pipeline but still want the same git and LLM behavior.
 
-## Development
+## Used By
 
-```bash
-npm test      # Jest + coverage
-npm run build # Rollup → dist/
-```
+This package is used by:
+
+- [sf-git-ai-meta-insights](https://github.com/mcarvin8/sf-git-ai-meta-insights) = Salesforce metadata wrapper compatible with Salesforce DX projects
 
 ## License