contrast-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
  # contrast-score 🌗
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/contrast-score.svg?style=flat-square)](https://www.npmjs.com/package/contrast-score)
4
+ [![CI](https://github.com/vjymisal0/contrast-score/actions/workflows/ci.yml/badge.svg)](https://github.com/vjymisal0/contrast-score/actions/workflows/ci.yml)
4
5
  [![license](https://img.shields.io/npm/l/contrast-score.svg?style=flat-square)](https://github.com/vjymisal0/contrast-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/contrast-score)
@@ -354,3 +355,7 @@ Build robust computer vision and document QA pipelines with our companion tools:
354
355
  ## 📄 License
355
356
 
356
357
  [MIT](LICENSE) © [Vijay Misal](https://github.com/vjymisal0)
358
+
359
+ ## Limitations
360
+
361
+ Scores depend on image dimensions, compression, and preprocessing. Treat them as pipeline signals, not universal image-quality grades.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "contrast-score",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Quantifies image and document contrast quality using Michelson contrast, RMS contrast, and luminance histogram distribution via Sharp. Optimized for pre-OCR document scanning and KYC verification.",
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",