@illusions-lab/mdi 2.0.3 → 2.0.4

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 +13 -0
  2. package/package.json +37 -37
package/README.md CHANGED
@@ -4,6 +4,12 @@ The JavaScript interface to the Rust-authoritative MDI engine. Give it a
4
4
  complete `.mdi` source document and it returns the versioned document IR and
5
5
  diagnostics produced by `mdi-core`.
6
6
 
7
+ ## Install
8
+
9
+ ```sh
10
+ npm install @illusions-lab/mdi
11
+ ```
12
+
7
13
  ```ts
8
14
  import { parse } from "@illusions-lab/mdi";
9
15
 
@@ -81,3 +87,10 @@ validation and serialization.
81
87
  The normative human-readable syntax is defined in
82
88
  [`SYNTAX.md`](https://github.com/illusions-lab/MDI/blob/main/SYNTAX.md). The
83
89
  executable syntax authority is `mdi-core`.
90
+
91
+ ## Documentation
92
+
93
+ - [JavaScript binding guide](https://mdi.illusions.app/bindings/javascript/)
94
+ - [Document IR and diagnostics](https://mdi.illusions.app/core/document-ir/)
95
+ - [Rendering model](https://mdi.illusions.app/core/rendering/)
96
+ - [MDI documentation](https://mdi.illusions.app/)
package/package.json CHANGED
@@ -1,38 +1,38 @@
1
1
  {
2
- "name": "@illusions-lab/mdi",
3
- "version": "2.0.3",
4
- "description": "Thin JavaScript binding for the Rust-authoritative MDI parser",
5
- "license": "MIT",
6
- "repository": {
7
- "type": "git",
8
- "url": "git+https://github.com/illusions-lab/MDI.git",
9
- "directory": "nodejs/packages/mdi"
10
- },
11
- "homepage": "https://mdi.illusions.app/",
12
- "bugs": "https://github.com/illusions-lab/MDI/issues",
13
- "type": "module",
14
- "main": "./dist/index.js",
15
- "types": "./dist/index.d.ts",
16
- "exports": {
17
- ".": {
18
- "types": "./dist/index.d.ts",
19
- "default": "./dist/index.js"
20
- }
21
- },
22
- "files": [
23
- "dist"
24
- ],
25
- "dependencies": {
26
- "@illusions-lab/mdi-core": "2.0.3"
27
- },
28
- "devDependencies": {
29
- "tsup": "^8.3.0",
30
- "typescript": "^5.6.0",
31
- "vitest": "^2.1.0"
32
- },
33
- "scripts": {
34
- "build": "tsup src/index.ts --format esm,cjs --dts",
35
- "test": "vitest run --passWithNoTests",
36
- "typecheck": "tsc --noEmit"
37
- }
38
- }
2
+ "name": "@illusions-lab/mdi",
3
+ "version": "2.0.4",
4
+ "description": "Thin JavaScript binding for the Rust-authoritative MDI parser",
5
+ "license": "MIT",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/illusions-lab/MDI.git",
9
+ "directory": "nodejs/packages/mdi"
10
+ },
11
+ "homepage": "https://mdi.illusions.app/",
12
+ "bugs": "https://github.com/illusions-lab/MDI/issues",
13
+ "type": "module",
14
+ "main": "./dist/index.js",
15
+ "types": "./dist/index.d.ts",
16
+ "exports": {
17
+ ".": {
18
+ "types": "./dist/index.d.ts",
19
+ "default": "./dist/index.js"
20
+ }
21
+ },
22
+ "files": [
23
+ "dist"
24
+ ],
25
+ "scripts": {
26
+ "build": "tsup src/index.ts --format esm,cjs --dts",
27
+ "test": "vitest run --passWithNoTests",
28
+ "typecheck": "tsc --noEmit"
29
+ },
30
+ "dependencies": {
31
+ "@illusions-lab/mdi-core": "workspace:*"
32
+ },
33
+ "devDependencies": {
34
+ "tsup": "^8.3.0",
35
+ "typescript": "^5.6.0",
36
+ "vitest": "^2.1.0"
37
+ }
38
+ }