bravais 0.1.3 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 0.2.0 - 2026-10-20
+
+- The first structure shows sooner, and the page no longer freezes while it
+  waits: the viewer and the thumbnail renderer compile all their shaders at
+  once when they are created, so the driver compiles them in parallel. On an
+  M2 Max with nothing cached, the first frame comes after 0.4 s instead of
+  0.7 s, and the longest freeze is 0.1 s instead of 0.65 s.
+- Right after a viewer is created, while its shaders compile, `setLayers` and
+  `render` draw once the shaders are ready instead of before they return.
+- The README example runs as written: it gives the viewer's container a height
+  and loads `examples/CoO.cif`, a COD structure the package now ships.
+
+## 0.1.4 - 2026-10-19
+
+- Switching structures is faster: the viewer keeps its compiled shaders
+  instead of compiling them again, builds the axes once instead of leaking a
+  new set on every switch, and resizes the canvas only when its size changes.
+- The README, the package description and the doc comments are shorter and
+  plainer.
+
 ## 0.1.3 - 2026-10-19
 
 - A layer at opacity 0 is no longer drawn but still frames the view, so a

package/README.md

@@ -3,7 +3,8 @@
 [![npm](https://img.shields.io/npm/v/bravais)](https://www.npmjs.com/package/bravais)
 [![CI](https://github.com/jcwang587/bravais/actions/workflows/ci.yml/badge.svg)](https://github.com/jcwang587/bravais/actions/workflows/ci.yml)
 
-A minimal crystal structure viewer for the web.
+A minimal crystal structure viewer for the web. Try the
+[demo](https://jcwang.dev/bravais/).
 
 ## Install
 
@@ -13,35 +14,37 @@ npm install bravais three
 
 ## Use
 
+Add a container with a height:
+
+```html
+<div id="viewer" style="height: 480px"></div>
+```
+
+Then read a CIF and visualize it:
+
 ```js
 import { buildScene, createViewer, expandStructure, readCif } from "bravais";
 
-const scene = buildScene(expandStructure(await readCif(cifText)));
+const response = await fetch("https://unpkg.com/bravais/examples/CoO.cif");
+const scene = buildScene(expandStructure(await readCif(await response.text())));
 createViewer(document.getElementById("viewer")).setLayers([{ scene }]);
 ```
 
 ## Built with
 
-- [three.js](https://threejs.org/): rendering, as a peer dependency.
-- [moyo](https://github.com/spglib/moyo): space-group
-  operations, bundled as WebAssembly.
-- [VESTA](https://jp-minerals.org/vesta/en/): the bond cutoffs, the element
-  colours, used here in Pretty Lattice's softened version, and the
-  occupancy pies.
-- [pymatgen](https://github.com/materialsproject/pymatgen): the copy of
-  VESTA's cutoff table this package ships.
-- OKLab: Björn Ottosson's public-domain colour formulas. They supply no
-  colours: they measure how alike two colours look, and move an element's
-  colour only when it would clash with one already on screen.
+- [three.js](https://threejs.org/) for rendering.
+- [moyo](https://github.com/spglib/moyo) for space-group symmetry.
+- [VESTA](https://jp-minerals.org/vesta/en/)'s bond cutoffs and occupancy
+  pies, with the cutoff table from
+  [pymatgen](https://github.com/materialsproject/pymatgen).
+- Björn Ottosson's OKLab colour space, to keep element colours apart.
 
 Thanks to Feitong Song's
-[Pretty Lattice](https://github.com/songfeitong/pretty-lattice), which this
-viewer follows in its lighting and materials, depth fading, trackball feel,
-axes gizmo, legend swatch, standard view and softened element colours.
+[Pretty Lattice](https://github.com/songfeitong/pretty-lattice), whose look,
+controls and softened element colours this viewer follows.
 
 The code was written by Claude Code, under the author's direction and review.
 
 ## License
 
-[MIT](LICENSE). Notices for the bundled third-party material are in
-[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+[MIT](LICENSE)

package/THIRD_PARTY_NOTICES.md

@@ -1,9 +1,9 @@
 # Third-party notices
 
 bravais is MIT licensed (see [LICENSE](LICENSE)). It ships material from the
-four MIT-licensed projects below, bundled into `dist/`. Each is reproduced
-with its copyright notice, and the MIT permission notice at the end applies
-to all four.
+four MIT-licensed projects below, bundled into `dist/`, and one example
+structure file. Each project is reproduced with its copyright notice, and the
+MIT permission notice at the end applies to all four.
 
 ## three.js
 
@@ -38,6 +38,14 @@ version of VESTA's element colours.
 
 Copyright (c) 2026 Feitong Song
 
+## Example structure
+
+`examples/CoO.cif`, the structure the README example loads, is entry 9008618
+of the [Crystallography Open Database](https://www.crystallography.net/cod/),
+shipped unchanged. Its header asks that the source of the data be credited:
+R. W. G. Wyckoff, _Crystal Structures_, vol. 1, 2nd ed., Interscience
+Publishers, New York, 1963.
+
 ## MIT permission notice
 
 Permission is hereby granted, free of charge, to any person obtaining a copy