zinkee 0.1.43 → 0.1.45

package/README.md

@@ -38,6 +38,10 @@ npm run typecheck
 npm test
 ```
 
+For reproducible before/after comparisons, see [performance benchmarks](docs/performance.md).
+The harness compares two built revisions using synthetic local fixtures, with timing,
+memory, request-count and output-correctness checks.
+
 ## Publishing
 
 Release steps for npm are documented in [docs/npm-release.md](docs/npm-release.md).
@@ -456,8 +460,8 @@ zinkee displays folders delete "Executive Dashboards"
 ### Creation flow
 
 1. Create the display
-2. Create context variables
-3. Create widgets with `variableMap` bindings
+2. Create context variables — optional; a display without variables shows every widget unfiltered
+3. Create widgets, binding them to the variables through `variableMap` if the display has any
 4. Set freeform layout positions
 
 ### Templates
@@ -492,11 +496,12 @@ Variables accept slugs for `--source-schema` and `--source-field`.
 
 ### Add widgets
 
-Every widget MUST include a `variableMap` that maps each display variable to a field in the widget's schema:
+A widget's `variableMap` maps display variables to fields in the widget's schema. It is optional: a
+widget that binds no variable shows its whole table, bounded only by its own filters.
 
 - **Same schema as variable**: bind to the same display field (e.g., `project-name`)
 - **Different schema**: bind to the ReferenceField pointing to the variable's schema (e.g., `task-project`)
-- **No filtering**: set to `null`
+- **No filtering**: set to `null`, or leave the variable out of the map
 
 ```bash
 # Table widget (--field accepts slugs)