sprae 8.1.2 → 8.1.3

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "sprae",
   "description": "DOM microhydration.",
-  "version": "8.1.2",
+  "version": "8.1.3",
   "main": "src/index.js",
   "module": "src/index.js",
   "type": "module",
   "files": [
-    "sprae.auto.js",
-    "sprae.auto.min.js",
-    "sprae.js",
-    "sprae.min.js",
+    "dist",
     "src"
   ],
   "dependencies": {
@@ -29,10 +26,10 @@
   "scripts": {
     "test": "node -r ./test/register.cjs test/test.js",
     "build": "npm run build-esm && npm run build-iife && npm run min",
-    "build-esm": "esbuild --bundle ./src/index.js --outfile=sprae.js --format=esm",
-    "build-iife": "esbuild --bundle ./src/index.js --outfile=sprae.auto.js --format=iife",
-    "watch": "esbuild --bundle ./src/index.js --outfile=sprae.js --format=esm --sourcemap --watch",
-    "min": "terser sprae.js -o sprae.min.js --module -c passes=3 -m && terser sprae.auto.js -o sprae.auto.min.js --module -c passes=3 -m"
+    "build-esm": "esbuild --bundle ./src/index.js --outfile=./dist/sprae.js --format=esm",
+    "build-iife": "esbuild --bundle ./src/index.js --outfile=./dist/sprae.auto.js --format=iife",
+    "watch": "esbuild --bundle ./src/index.js --outfile=./dist/sprae.js --format=esm --sourcemap --watch",
+    "min": "terser ./dist/sprae.js -o ./dist/sprae.min.js --module -c passes=3 -m && terser ./dist/sprae.auto.js -o ./dist/sprae.auto.min.js --module -c passes=3 -m"
   },
   "repository": {
     "type": "git",

package/readme.md

@@ -2,10 +2,10 @@
 
 > DOM tree hydration with reactivity.
 
-_Sprae_ is compact ergonomic[*](#justification--alternatives) progressive enhancement framework.<br/>
+_Sprae_ is compact ergonomic progressive enhancement framework.<br/>
 It provides reactive `:`-attributes that enable simple markup logic without need for complex scripts.<br/>
 Perfect for small-scale websites, prototypes or UI logic.<br/>
-It is tiny and performant alternative to [alpine](https://github.com/alpinejs/alpine), [petite-vue](https://github.com/vuejs/petite-vue) or [template-parts](https://github.com/github/template-parts).
+It is tiny, performant and open alternative to [alpine](https://github.com/alpinejs/alpine), [petite-vue](https://github.com/vuejs/petite-vue) or [template-parts](https://github.com/github/template-parts).
 
 ## Usage
 
@@ -14,7 +14,7 @@ It is tiny and performant alternative to [alpine](https://github.com/alpinejs/al
 To autoinit document, include [`sprae.auto.js`](./sprae.auto.js):
 
 ```html
-<!-- <script src="https://cdn.jsdelivr.net/npm/sprae/sprae.auto.js" defer></script> -->
+<!-- <script src="https://cdn.jsdelivr.net/npm/sprae/dist/sprae.auto.js" defer></script> -->
 <script defer src="./path/to/sprae.auto.js"></script>
 
 <ul>
@@ -34,7 +34,7 @@ To init manually as module, import [`sprae.js`](./sprae.js):
 </div>
 
 <script type="module">
-  // import sprae from 'https://cdn.jsdelivr.net/npm/sprae/sprae.js';
+  // import sprae from 'https://cdn.jsdelivr.net/npm/sprae/dist/sprae.js';
   import sprae from './path/to/sprae.js';
 
   const state = sprae(container, { user: { name: 'Dmitry Ivanov' } });
@@ -50,6 +50,8 @@ Sprae creates reactive state that mirrors current DOM values.<br/>
 It is based on [signals](https://github.com/preactjs/signals) and can take them as inputs.
 
 ```js
+import { signal } from '@preact/signals-core'
+
 const version = signal('alpha')
 
 // Sprae container with initial state values
@@ -282,6 +284,12 @@ To destroy state and detach sprae handlers, call `element[Symbol.dispose]()`.
 
 See [js-framework-benchmark](https://krausest.github.io/js-framework-benchmark/current.html#eyJmcmFtZXdvcmtzIjpbIm5vbi1rZXllZC9wZXRpdGUtdnVlIiwibm9uLWtleWVkL3NwcmFlIl0sImJlbmNobWFya3MiOlsiMDFfcnVuMWsiLCIwMl9yZXBsYWNlMWsiLCIwM191cGRhdGUxMHRoMWtfeDE2IiwiMDRfc2VsZWN0MWsiLCIwNV9zd2FwMWsiLCIwNl9yZW1vdmUtb25lLTFrIiwiMDdfY3JlYXRlMTBrIiwiMDhfY3JlYXRlMWstYWZ0ZXIxa194MiIsIjA5X2NsZWFyMWtfeDgiLCIyMV9yZWFkeS1tZW1vcnkiLCIyMl9ydW4tbWVtb3J5IiwiMjNfdXBkYXRlNS1tZW1vcnkiLCIyNV9ydW4tY2xlYXItbWVtb3J5IiwiMjZfcnVuLTEway1tZW1vcnkiLCIzMV9zdGFydHVwLWNpIiwiMzRfc3RhcnR1cC10b3RhbGJ5dGVzIiwiNDFfc2l6ZS11bmNvbXByZXNzZWQiLCI0Ml9zaXplLWNvbXByZXNzZWQiXSwiZGlzcGxheU1vZGUiOjF9).
 
+<details>
+<summary>Results table</summary>
+
+![Benchmark](./bench.png)
+</details>
+
 <details>
 <summary>How to run</summary>
 
@@ -292,7 +300,7 @@ npm run install-server
 npm start
 
 # build
-cd frameworks/keyed/sprae
+cd frameworks/non-keyed/sprae
 npm ci
 npm run build-prod