doxa-life/doxa-maps
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: front-load the opening (drop the 'bottom line up front' label), tighten for brevity
Some checks are pending
Deploy to GitHub Pages / build (push) Waiting to run
Details
Deploy to GitHub Pages / deploy (push) Blocked by required conditions
Details

Browse source 
Lead with the one-liner + the two commands immediately after the tagline; punchier
bullets; condensed the data caveat. Same content, fewer words, essence first.
This commit is contained in:
doxa-maps 2026-09-15 23:39:01 +00:00
parent 15205d3ce1
commit d2b8ad979f
1 changed files with 8 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,22 +1,17 @@
# doxa-maps — a JAMstack map bundler for vibe coders
> **Built by a vibe coder, for vibe coders.** If you use AI to write your code and you dream
> of making maps to reach your city — your nation — every people group — for Jesus, this is for you.
> **Built by a vibe coder, for vibe coders** — for anyone using AI to build maps that reach every
> people, in every place, for Jesus.
---
**One repo holds *all* your maps and turns them into embeddable apps with one command.**
## Bottom line up front
- **One folder, not fifty** — every map in one repo, on one shared component library.
- **`bun run dev`** → preview every map in a live playground, each with a copy‑paste embed snippet.
- **`bun run build`** → each map becomes a self‑contained file: drop it on any site or WordPress, compose several into a **single‑page app**, or wrap it as a **mobile app** — *same code, every target.*
**doxa-maps is one repository that holds *all* your maps and turns them into embeddable apps with a single command.**
**You don't write the code.** Point your AI agent at the example maps, describe what you want in plain English, and it builds a new one on the shared library.
- **One folder for every map.** Not 50 folders scattered across your laptop — one repo, one shared library.
- **One command to preview:** `bun run dev` → a live playground showing every map in one place, each with a copy‑paste embed snippet.
- **One command to ship:** `bun run build` → every map comes out as a self‑contained file you can drop onto **any** website (your site, a partner church's site, WordPress), compose into a **single‑page app**, or wrap into a **mobile app** — *from the same code.*
You don't have to write the code yourself. Point your AI agent at the example maps in this repo, describe the map you want in plain English, and it builds a new one that reuses the shared library.
> ⚠️ **These maps do not come with their data.** They're JAMstack (pure JavaScript), so they fetch their
> data — like people groups — from an **API** at runtime. See **[The data caveat](#the-data-caveat)** below.
> ⚠️ **Maps ship without data** — being JAMstack (pure JS), they fetch it (like people groups) from an **API** at runtime ([details](#the-data-caveat)).
---