@avodado/sync 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Avodado contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# @avodado/sync
+
+Import external sources into Avodado documents. v1 supports **OpenAPI 3.x**
+specs; more importers can land here later (SQL DDL, JSON Schema, …).
+
+## CLI
+
+```bash
+# Generate a doc from an OpenAPI spec
+avo sync openapi openapi.yaml --out docs/api.md
+
+# Check that the existing doc matches what the spec would generate (CI-friendly)
+avo sync openapi openapi.yaml --check docs/api.md
+```
+
+The generated doc contains:
+
+- `meta` — title / subtitle / version from `info`
+- `prose` — the API description
+- `table` — every endpoint (method · path · summary)
+- One `sequence` per endpoint (with method-coloured tag, status codes as messages)
+- `erd` — every named schema from `components/schemas`
+
+The generated doc is **strict**: re-running the sync produces byte-identical
+output. The `--check` mode fails CI if the doc has drifted from the spec.
+
+## Library
+
+```ts
+import { openapiToMarkdown, parseOpenApi } from '@avodado/sync';
+import { readFileSync } from 'node:fs';
+
+const spec = parseOpenApi(readFileSync('openapi.yaml', 'utf8'));
+const md = openapiToMarkdown(spec, { slug: 'api' });
+```