Skip to content

Commit eb55e1d

Browse files
committed
Document package quality metadata
1 parent 7a849b4 commit eb55e1d

4 files changed

Lines changed: 25 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes to this package are documented here.
4+
5+
## 0.4.1 - 2026-05-12
6+
7+
- Added ecosystem recipes showing how to combine `json-html-kit` with small parsing and table utilities.
8+
- Added GitHub Actions CI for typechecking, building and testing on Node.js 20 and 22.
9+
- Documented package quality signals in the README.
10+

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ Modern TypeScript utilities for rendering arbitrary JSON as safe, themed, human-
88

99
Demo: https://json-html-kit.wasta-wocket.fr/
1010

11+
## Package quality
12+
13+
- TypeScript types are generated from the source.
14+
- ESM-only package with no runtime dependencies.
15+
- Marked as side-effect free for bundlers.
16+
- Tested on Node.js 20 and 22 with GitHub Actions.
17+
- Designed to work without framework lock-in.
18+
1119
## Goals
1220

1321
- Render unknown JSON into readable HTML without framework lock-in.

package-lock.json

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "0.4.1",
44
"description": "Render arbitrary JSON as safe, themed, human-friendly HTML tables.",
55
"type": "module",
6+
"sideEffects": false,
67
"license": "MIT",
78
"author": "Recoveredd",
89
"repository": {
@@ -36,6 +37,9 @@
3637
"publishConfig": {
3738
"access": "public"
3839
},
40+
"engines": {
41+
"node": ">=20"
42+
},
3943
"scripts": {
4044
"build": "npm run build:lib",
4145
"build:lib": "tsc -p tsconfig.build.json",

0 commit comments

Comments
 (0)