@turndown/library 0.1.64 → 0.1.65

package/README.md

@@ -1 +1,41 @@
-# turndown-types
+# @turndown/library
+
+Shared TypeScript contracts and validation utilities for the Turndown suite.
+
+This package is intended to stay small and contract-focused. It should contain API DTOs, route request/response types, constants, validation schemas, and stable client-facing error shapes.
+
+## Public entry points
+
+```ts
+import { IPropertyDetail } from "@turndown/library";
+import { IPropertyDetail } from "@turndown/library/types";
+import { createValidationSchema } from "@turndown/library/validation";
+```
+
+Helpers are intentionally not exported from the package root. Use the explicit helper entry point when legacy helper utilities are needed:
+
+```ts
+import { formatAddress } from "@turndown/library/helpers";
+```
+
+## Boundary rules
+
+Do not add runtime-owned implementation details to this package:
+
+- Express middleware
+- database rows or repositories
+- token hashes or password hashes
+- storage bucket names or object keys
+- service orchestration
+- UI screen/form view models
+- provider clients
+
+Backend-only and frontend-only models should live in their owning application packages.
+
+## Checks
+
+```bash
+npm test -- --runInBand
+npm run check
+npm run build
+```