wiki-plugin-globe 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# wiki-plugin-globe
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A Federated Wiki plugin that draws a [globe.gl](https://globe.gl) globe from pins the
+wiki already holds: the pins of Map items, the points of a GeoJSON file, and pins typed
+into the item. Whatever it shows it offers back as `markerData()`, so a Map item can
+gather and freeze it.
+
+    LAYER Embassies
+    PAGE
+    LAYER Places
+    SOURCE /assets/my-page/places.geojson
+    51.5, -0.1 A pin typed here, with a [[Link]]
+    VIEW 51.5, -0.1, 0.4
+    SHOW Places
+    Any other line is a caption.
+
+- **Two halves.** `client/globe.js` is the shell on the wiki page; `client/globe.html`
+  draws the globe in a sandboxed frame. They talk by messages (`globeReady`,
+  `globePoints`, `globeFly`, `globeOpen`).
+- **Offline.** globe.gl, topojson-client and the land outline are copied into `client/`
+  at build time. Nothing is fetched from a CDN.
+- **Degrades.** `globe.html` in a plain Frame item reads Map items through the Frame
+  plugin's `requestSourceData`, with `?data=<geojson>` as a fallback.
+- **Accessible.** The same pins are listed beneath the globe; reduced motion is respected.
+- **Freezes.** The snowflake writes the pins into the item as `frozen` — the Map plugin's shape,
+  plus a `layer` name — so a frozen globe draws with no file and no neighbours, and survives a
+  fork. Shift-click thaws. The ⌖ button saves the camera (`VIEW`) and the chosen layer (`SHOW`).
+
+Version 0.2 draws points only. Research and plan: <https://place.fish/view/globe-plugin>,
+<https://place.fish/view/globe-plugin-plan>.
+
+    npm install && npm test && npm run build