spacemap 0.1.16 → 0.1.18

package/README.md

@@ -1,14 +1,14 @@
 # spacemap
 
 The map of the Solar System from [spacemap.co](https://spacemap.co), on your
-website! There are flat maps too, 360 panoramas from the surface, and a
-diagram of the whole system to pick a body from.
+website! Also available: flat maps, 360 panoramas from the surface, and diagrams
+of the solar systems and satellite systems.
 
 Distances are kilometres and angles are degrees throughout. Objects are named
-by their export id — `naif-399` for Earth, `spkid-20000004` for Vesta,
+by their export id: `naif-399` for Earth, `spkid-20000004` for Vesta,
 `norad_satcat-25544` for the ISS.
 
-No key, no quota for now.
+No key or quota for now.
 
 ## Licensing
 
@@ -24,20 +24,14 @@ the SDK draws only what a page may use:
 - **Non-commercial** imagery and models are licensed for educational and
   non-commercial use: the Uranus map, the Huygens descent panorama of Titan,
   and the models of a few craft, most of them Soviet (Buran, Vostok, Lunokhod,
-  Salyut 1). A page that is not commercial turns them on:
+  Salyut 1). These can be turned on, for non-commmercial projects only, with:
 
   ```js
   const map = await createMap({ container: '#map', includeNonCommercial: true });
   ```
 
   Asking for it is accepting its terms, and the credit line naming each author
-  is part of those terms. Without the flag Uranus renders in a flat fallback
-  colour, the Huygens stop is a place on Titan with no panorama to open, and
-  those craft stay markers with no model. Mir is the exception: it has an open
-  model too, and the map draws that one.
-
-- **Site-only** imagery is licensed to spacemap.co alone and never reaches the
-  SDK.
+  is part of those terms. Do not hide it.
 
 ## Getting it
 
@@ -47,7 +41,7 @@ your page:
 ```html
 <div id="map" style="height: 500px"></div>
 <script type="module">
-	import { createMap } from 'https://cdn.jsdelivr.net/npm/spacemap@0.1.16/dist/spacemap.js';
+	import { createMap } from 'https://cdn.jsdelivr.net/npm/spacemap@0.1.18/dist/spacemap.js';
 	const map = await createMap({ container: '#map' });
 </script>
 ```
@@ -86,13 +80,15 @@ const map = await createMap({
 
 ```js
 await map.flyTo({ body: 'naif-599' }); // fly, framing it for you
-map.jumpTo({ body: 'naif-599', distanceKm: 2e6 }); // no flight
-map.jumpTo({ body: 'naif-399', facing: 'naif-10', elevationDeg: 30 });
+await map.jumpTo({ body: 'naif-599', distanceKm: 2e6 }); // no flight
+await map.jumpTo({ body: 'naif-399', facing: 'naif-10', elevationDeg: 30 });
 map.getCamera(); // { body, lat, lon, distanceKm }
 ```
 
-`flyTo` resolves when the flight lands. What a target leaves out the map frames
-itself, so `{ body }` alone is the ordinary way to move.
+`flyTo` resolves when the flight lands, and `jumpTo` one frame after the camera
+is in its place. Both load a body the map does not hold yet. What a target
+leaves out the map frames itself, so `{ body }` alone is the ordinary way to
+move.
 
 Clicking a named surface feature reports it; `panTo` turns to one without
 travelling:
@@ -123,6 +119,7 @@ hold.release();
 | `featureselect`                   | a nomenclature label was clicked                   |
 | `clock`                           | the date, play state, rate or direction changed    |
 | `loading` / `progress`            | data is coming in                                  |
+| `idle`                            | the camera is at rest and the view is fully loaded |
 | `error`                           | the data could not be loaded                       |
 | `notice` / `noticedismiss`        | a condition worth telling the reader about         |
 | `layerschange`                    | a layer was switched                               |
@@ -140,15 +137,18 @@ map was opened on a date.
 map.clock.pause();
 map.clock.setTimeScale(86400); // a day a second
 map.clock.toggleDirection();
-map.clock.setDate(new Date('2035-06-01'));
+await map.clock.setDate(new Date('2035-06-01'));
 map.clock.now();
 ```
 
+`setDate` resolves when a frame shows the bodies at the new date. The data for
+a date can take time to load, and until then the map shows the date before.
+
 ### Measuring
 
 Some things can be read off the scene instead of drawn on it. All take the
-bodies where the last frame put them, so after `setDate` wait for a `frame`
-before asking.
+bodies where the last frame put them, so after `setDate` wait for the promise
+it returns before asking.
 
 ```js
 // Kilometres between two anchors: centres, places on a surface, or one of each.