From 9a7c6304f7fcef4ef9c03f56f9a81225781dd0f5 Mon Sep 17 00:00:00 2001 From: Doxa Maps Date: Fri, 25 Sep 2026 23:37:31 +0000 Subject: [PATCH] =?UTF-8?q?README:=20what=20the=20library=20gives=20every?= =?UTF-8?q?=20map=20=E2=80=94=20two=20engines,=20a=20key=20or=20a=20key=20?= =?UTF-8?q?service,=2011=20languages,=20web=20components,=20maps=20that=20?= =?UTF-8?q?talk=20to=20each=20other,=20tree-shaken=20bundles,=20one=20buil?= =?UTF-8?q?d,=20three=20outputs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ed1700a29..d1333d720 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,19 @@ Made by Vibe Coders for Vibe Coders to prepare the way of the Lord and make His iframe, script embed, mobile app β€” or open every map at once as one app. Five plugin capabilities, three outputs, one shared library, one build. +### What the library gives every map + +| | | +|---|---| +| πŸ—ΊοΈ **Two map engines** | Every map draws with **Mapbox** or **MapLibre** (free, no key) β€” switch with `"provider"` in its settings or `?provider=maplibre` in the address. Mapbox is the default. | +| πŸ”‘ **A key or a key service** | Give Mapbox a public token, or the address of a token service that hands one out β€” set once in the Plugin Studio header. | +| 🌍 **11 languages** | `?lang=` or `"locale"`, with Arabic right to left β€” [Languages](#languages). | +| 🧩 **Web components** | Each map is its own HTML tag, like ``, that works on any page β€” no framework needed. | +| πŸ”— **Maps that talk to each other** | Maps share props and events, so one app can nest them and a click in one can move another. | +| πŸͺΆ **Small bundles** | Each map's file carries only the parts of the shared library it uses (tree-shaken). | +| βš™οΈ **One build step** | `bun run build` makes every map at once. | +| πŸ“¦ **Three outputs** | A web folder (iframe, script embed), a mobile app, a desktop app β€” [the 3 outputs](#what-the-build-makes--3-outputs). | + | What dx-maps set out to do | Proof | |---|---| | **One build β†’ one folder** you can drop on any host | `bun run check:drop` |