From 6785dd826b229925f9ad0776a7ac1757d5e7b91f Mon Sep 17 00:00:00 2001 From: doxa-maps Date: Fri, 11 Sep 2026 17:43:48 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20README=20leads=20with=20plain-words=20e?= =?UTF-8?q?xplainer=20=E2=80=94=20bundler,=20bundles,=20elements,=20lean/t?= =?UTF-8?q?ree-shaken,=20embed=20anywhere,=20SPA,=20JAMstack=20hot-swap?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 47 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 35 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f5a8f1d5b..dd0e08aa7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,43 @@ # doxa-maps -**A portable bundler that generates JAMstack maps that embed on all your partner sites.** +**A bundler that turns your maps into small embeddable pieces you can drop onto any website.** > ### ✨ New here, and you don't write code? > You can build real, embeddable maps by **describing them to an AI coding agent** — no > programming required. Start with the friendly, zero-jargon guide: > **[docs/tutorial.md](./docs/tutorial.md)**. +## In plain words + +**What a bundler is.** It's a tool that takes your map code and packages it into a small, +ready-to-use file. You write the map once; the bundler produces the shippable piece. + +**What it outputs.** Plain `.js` files in the `public/` folder — one per bundle. That's it. +No server, no build step on anyone else's side. Serve the folder from anywhere and the maps work. + +**What a bundle is.** A self-contained web component — a custom HTML tag like ``. You add +one `