uidl-runtime 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +17 -1
  2. package/package.json +12 -3
package/README.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # uidl-runtime
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/uidl-runtime.svg)](https://www.npmjs.com/package/uidl-runtime)
4
+ [![CI](https://github.com/hi-donwi/UIDL-Runtime/actions/workflows/ci.yml/badge.svg)](https://github.com/hi-donwi/UIDL-Runtime/actions/workflows/ci.yml)
5
+ [![license: MIT](https://img.shields.io/npm/l/uidl-runtime.svg)](LICENSE)
6
+
3
7
  A schema-driven React runtime that renders validated JSON documents into real application
4
8
  surfaces — lists, forms, reports, dashboards and settings — without putting business
5
9
  workflows inside page components.
@@ -14,6 +18,12 @@ It was built for three callers: AI agents that generate interfaces from structur
14
18
  instructions, ERP-style products whose screens are defined by metadata rather than code, and
15
19
  low-code systems that need a validated document model instead of generated page files.
16
20
 
21
+ ## Install
22
+
23
+ ```bash
24
+ npm install uidl-runtime
25
+ ```
26
+
17
27
  ```tsx
18
28
  import { DocumentSchema, UIDocumentRenderer, meridianLightTheme } from "uidl-runtime";
19
29
  import "uidl-runtime/style.css";
@@ -41,11 +51,17 @@ certified systems — read the maturity table below before treating any of them
41
51
  - 11 industry reference consoles plus a full double-entry accounting reference
42
52
  - Every financial posting satisfies `sum(debit) === sum(credit)`, checked by an audit gate
43
53
 
44
- ## Quick start
54
+ ## Contributing to this repository
55
+
56
+ The rest of this document is for working on `uidl-runtime` itself — the runtime, the
57
+ reference suite, and the build. If you only want to consume the library, `npm install
58
+ uidl-runtime` above is all you need.
45
59
 
46
60
  Node.js LTS and npm.
47
61
 
48
62
  ```bash
63
+ git clone https://github.com/hi-donwi/UIDL-Runtime.git
64
+ cd UIDL-Runtime
49
65
  npm install
50
66
  npm run dev
51
67
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "uidl-runtime",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "main": "./dist/uidl-runtime.js",
5
5
  "module": "./dist/uidl-runtime.mjs",
6
6
  "types": "./dist/index.d.ts",
@@ -15,7 +15,7 @@
15
15
  "./schema/*.json": "./dist/schema/*.json"
16
16
  },
17
17
  "bin": {
18
- "uidl-validate": "./bin/validate.mjs"
18
+ "uidl-validate": "bin/validate.mjs"
19
19
  },
20
20
  "files": [
21
21
  "dist",
@@ -105,5 +105,14 @@
105
105
  "low-code",
106
106
  "ui-runtime",
107
107
  "erp"
108
- ]
108
+ ],
109
+ "author": "donwi <hi.donwi@gmail.com>",
110
+ "repository": {
111
+ "type": "git",
112
+ "url": "git+https://github.com/hi-donwi/UIDL-Runtime.git"
113
+ },
114
+ "homepage": "https://github.com/hi-donwi/UIDL-Runtime#readme",
115
+ "bugs": {
116
+ "url": "https://github.com/hi-donwi/UIDL-Runtime/issues"
117
+ }
109
118
  }