docs: npm best practices — expanded README + bundlephobia badge

README.md

@@ -1,39 +1,65 @@
-# caiq-lite
+# @hailbytes/caiq-lite
 
 > Programmatic schema and validator for the CSA CAIQ-Lite vendor security questionnaire. Author, validate, and diff CAIQ responses as code.
 
 [![npm version](https://img.shields.io/npm/v/%40hailbytes%2Fcaiq-lite.svg)](https://www.npmjs.com/package/%40hailbytes%2Fcaiq-lite)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Bundle Size](https://img.shields.io/bundlephobia/minzip/%40hailbytes%2Fcaiq-lite)](https://bundlephobia.com/package/@hailbytes/caiq-lite)
 
-## Who Is This For
+---
 
-Security engineers, compliance teams, and trust-center operators who need to automate the authoring, validation, and delivery of CSA CAIQ-Lite vendor security questionnaires.
+## What it does
+
+Treat your CSA CAIQ-Lite vendor security questionnaire as code. Load responses from YAML, validate them against the official schema, diff versions over time, and export to PDF, XLSX, JSON, or Markdown — all programmatically.
+
+---
+
+## Install
+
+```bash
+npm install @hailbytes/caiq-lite
+```
+
+---
 
-## API
+## Quick Start
 
 ```ts
 import { loadCAIQ, validate, diff, exportTo } from '@hailbytes/caiq-lite';
 
-// Load a CAIQ response from YAML
+// 1. Load a CAIQ response from YAML
 const caiq = await loadCAIQ('responses.yaml');
 
-// Validate against the CAIQ-Lite schema
+// 2. Validate against the CAIQ-Lite schema
 const result = validate(caiq);
+if (!result.valid) {
+  console.error(result.errors);
+}
 
-// Diff two CAIQ responses
+// 3. Diff two CAIQ responses
 const changes = diff(previousCAIQ, currentCAIQ);
+console.log(changes.added, changes.removed, changes.modified);
 
-// Export to multiple formats
+// 4. Export to multiple formats
 const pdf = await exportTo(caiq, { format: 'pdf' });
 const xlsx = await exportTo(caiq, { format: 'xlsx' });
 const json = await exportTo(caiq, { format: 'json' });
 const md = await exportTo(caiq, { format: 'markdown' });
 ```
 
+---
+
+## Who Is This For
+
+Security engineers, compliance teams, and trust-center operators who need to automate the authoring, validation, and delivery of CSA CAIQ-Lite vendor security questionnaires.
+
+---
+
 ## See Also
 
 - [`@hailbytes/sbom-diff`](https://github.com/HailBytes/sbom-diff) — Diff CycloneDX/SPDX SBOMs
 - [HailBytes](https://hailbytes.com)
+
 ---
 
 *Part of the [HailBytes](https://hailbytes.com) open-source security toolkit.*

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hailbytes/caiq-lite",
-  "version": "0.0.1",
+  "version": "1.0.1",
   "description": "Programmatic schema and validator for the CSA CAIQ-Lite vendor security questionnaire. Author, validate, and diff CAIQ responses as code.",
   "type": "module",
   "license": "MIT",