@sdk-it/readme 0.46.0 → 0.46.2

package/README.md

@@ -0,0 +1,33 @@
+# @sdk-it/readme
+
+Render the documentation stored in SDK-IT's processed intermediate
+representation as Markdown. Language generators use this package when
+creating generated SDK documentation.
+
+## Install
+
+```bash
+npm install @sdk-it/readme @sdk-it/spec
+```
+
+## Render Markdown
+
+```typescript
+import { writeFile } from 'node:fs/promises';
+
+import { toReadme } from '@sdk-it/readme';
+import { loadSpec, toIR } from '@sdk-it/spec';
+
+const spec = await loadSpec('./openapi.yaml');
+const ir = await toIR({ spec });
+const markdown = toReadme(ir);
+
+await writeFile('./README.md', markdown);
+```
+
+`toReadme` accepts an `IR`, not a raw OpenAPI object. Process the document
+with `toIR` first so operation metadata and generated overview sections are
+available.
+
+The package also exports the `Generator` interface used by language-specific
+documentation and snippet generators.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdk-it/readme",
-  "version": "0.46.0",
+  "version": "0.46.2",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -22,8 +22,8 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@sdk-it/core": "0.46.0",
-    "@sdk-it/spec": "0.46.0",
+    "@sdk-it/core": "0.46.2",
+    "@sdk-it/spec": "0.46.2",
     "openapi3-ts": "4.5.0"
   }
 }