@tangram.gl/tangram-layers 0.0.0-stage → 0.0.1

package/README.md

@@ -1,3 +1,37 @@
-# Temporary Holding Version
+<!--
+tangram-layers
+SPDX-License-Identifier: MIT
+Copyright (c) vis.gl contributors
+-->
 
-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.
+# @tangram.gl/tangram-layers
+
+Experimental deck.gl basemap integration for tangram.gl. Install with
+`npm install @tangram.gl/tangram-layers`, or build from the repository root
+with `yarn build:modules`.
+
+```js
+import {Deck, MapView} from '@deck.gl/core';
+import {TangramLayer} from '@tangram.gl/tangram-layers';
+
+const deck = new Deck({
+  canvas: 'map',
+  views: new MapView(),
+  initialViewState: {longitude: -74, latitude: 40.7, zoom: 12},
+  controller: true,
+  layers: [new TangramLayer({id: 'basemap', scene: 'scene.yaml'})]
+});
+```
+
+The layer accepts a scene URL or object, uses deck.gl's active luma.gl device and
+render pass, and supports flat/perspective MapView plus experimental GlobeView
+and FirstPersonView. The current peer stack is deck.gl/luma.gl 9.4; use compatible
+versions sharing one device runtime.
+
+- [TangramLayer properties and limitations](https://vis.gl/tangram.gl/docs/api-reference/tangram-layer)
+- [Experimental projected basemaps](https://vis.gl/tangram.gl/docs/developer-guide/projected-basemaps)
+- [Experimental WebXR presentation](https://vis.gl/tangram.gl/docs/api-reference/webxr-presentation)
+
+The experimental subpaths are opt-in and do not enter the ordinary layer bundle.
+Display the scene's required attribution through `onAttributionChange`; the layer
+does not mount a credit control. See the API reference for safe presentation.