glare-score 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,9 @@
1
+ # Changelog
2
+
3
+ ## 1.0.2
4
+
5
+ - Expanded API documentation and documented limitations.
6
+
7
+ ## 1.0.0
8
+
9
+ - Documented package metadata and release baseline.
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # glare-score 💡
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/glare-score.svg?style=flat-square)](https://www.npmjs.com/package/glare-score)
4
+ [![CI](https://github.com/vjymisal0/glare-score/actions/workflows/ci.yml/badge.svg)](https://github.com/vjymisal0/glare-score/actions/workflows/ci.yml)
4
5
  [![license](https://img.shields.io/npm/l/glare-score.svg?style=flat-square)](https://github.com/vjymisal0/glare-score/blob/main/LICENSE)
5
6
  [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg?style=flat-square)](https://www.typescriptlang.org)
6
7
  [![Build & Tests](https://img.shields.io/badge/tests-passing-brightgreen.svg?style=flat-square)](https://github.com/vjymisal0/glare-score)
@@ -279,3 +280,7 @@ npm run typecheck
279
280
  ## 📄 License
280
281
 
281
282
  [MIT](LICENSE) © [Vijay Misal](https://github.com/vjymisal0)
283
+
284
+ ## Limitations
285
+
286
+ Glare detection is heuristic and may flag bright text or reflective surfaces. Calibrate thresholds for your capture conditions.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "glare-score",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Detect and quantify specular glare and flash reflection hotspots in images. Optimized for pre-OCR document scanning, KYC ID card verification, and photo quality pipelines.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -16,7 +16,8 @@
16
16
  "files": [
17
17
  "dist",
18
18
  "README.md",
19
- "LICENSE"
19
+ "LICENSE",
20
+ "CHANGELOG.md"
20
21
  ],
21
22
  "scripts": {
22
23
  "build": "tsup",