@felan-ai/ext-markitdown 0.0.0 → 0.2.0

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 +37 -0
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -65,3 +65,40 @@ much faster.
65
65
  The automatic `read` interception is available only while the ordinary `read`
66
66
  tool is active. Felan's Codex mode currently replaces that tool, so this
67
67
  extension does not add a second Codex-specific document tool.
68
+
69
+ ## Composition and package boundary
70
+
71
+ ```ts
72
+ import markitdownExtension from '@felan-ai/ext-markitdown';
73
+
74
+ const extension = markitdownExtension;
75
+ ```
76
+
77
+ The package owns format selection, bounded staging, conversion diagnostics, and
78
+ cache redirection. The host supplies `AgentRuntime`, installation policy, and
79
+ the `markitdown` executable. It requires a compatible `@felan-ai/agent-core`
80
+ peer and Python 3.10 or newer only when the managed converter is installed.
81
+
82
+ ## Development
83
+
84
+ Source: `packages/ext-markitdown` in <https://github.com/felan-ai/felan>.
85
+
86
+ ```sh
87
+ corepack enable
88
+ pnpm install --frozen-lockfile
89
+ pnpm --filter @felan-ai/ext-markitdown build
90
+ pnpm --filter @felan-ai/ext-markitdown type-check
91
+ pnpm --filter @felan-ai/ext-markitdown test
92
+ ```
93
+
94
+ ## Related documentation
95
+
96
+ - [Web, MCP, browser, and documents](../../docs/user-guide/web-mcp-and-browser.md)
97
+ - [Runtime dependencies](../../docs/reference/runtime-dependencies.md)
98
+ - [Runtime and security](../../docs/concepts/runtime-and-security.md)
99
+
100
+ ## Attribution
101
+
102
+ The package adapts reviewed `pi-markitdown` behavior and interoperates with
103
+ Microsoft MarkItDown 0.1.7, which is installed separately when requested. It
104
+ does not bundle the Python converter. See [NOTICE](NOTICE) and [LICENSE](LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@felan-ai/ext-markitdown",
3
- "version": "0.0.0",
3
+ "version": "0.2.0",
4
4
  "description": "Bounded MarkItDown document conversion for Felan read workflows",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -25,10 +25,10 @@
25
25
  }
26
26
  },
27
27
  "peerDependencies": {
28
- "@felan-ai/agent-core": "^0.4.0"
28
+ "@felan-ai/agent-core": "^0.5.0"
29
29
  },
30
30
  "devDependencies": {
31
- "@felan-ai/agent-core": "0.4.9"
31
+ "@felan-ai/agent-core": "0.5.0"
32
32
  },
33
33
  "publishConfig": {
34
34
  "access": "public",
@@ -39,4 +39,4 @@
39
39
  "type-check": "tsc -p tsconfig.json --noEmit",
40
40
  "test": "vitest run"
41
41
  }
42
- }
42
+ }