readme

greggman · Dec 15, 2023 · 1bf498e · 1bf498e
1 parent 506d26c
commit 1bf498e
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/CHANGELIST.md b/CHANGELIST.md
@@ -1,5 +1,25 @@
 # Change List
 
+### 1.0.0
+
+* switch primitive functions to use named parameters.
+
+### 0.15.0
+
+* add `setIntrinsicsToView`
+
+### 0.14.3
+
+* Fixes for vec2 typos
+
+### 0.14.2
+
+* Handle bool issue fix
+
+### 0.14.0
+
+* Use latest wgsl_reflect
+
 ### 0.13.0
 
 * Support making views of unsized arrays

diff --git a/README.md b/README.md
@@ -6,6 +6,9 @@
 
 See [here](https://greggman.github.io/webgpu-utils/docs)
 
+* [ChangeList](https://github.com/greggman/webgpu-utils/CHANGELIST.md)
+* [Migration Notes](https://github.com/greggman/webgpu-utils/migration.md)
+
 ## Random useful things for WebGPU
 
 As I do more WebGPU I find I need more and more helpers to make things

diff --git a/migration.md b/migration.md
@@ -0,0 +1,12 @@
+# Migration Notes
+
+## 0.x -> 1.x
+
+* primitive functions changed to named parameters
+
+  * old: `createSphereVertices(2, 12)`
+  * new: `createSphereVertices({radius = 2, subdivisionsAxis = 12})`
+
+  This means you only have to specify what you change where as with
+  the previous style you had to specify everything up to the parameter
+  you actually wanted to change.