@use-raf/state 0.0.2 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 einouqo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,7 +1,25 @@
 # @use-raf/state
 
+[![npm-version-badge]][npm-link]
+[![npm-downloads-badge]][npm-link]
+[![bundle-size-badge]][bundlephobia-link]
+[![types-badge]][npm-link]
+[![license-badge]][license-link]
+
 A React hook that synchronizes state updates with `requestAnimationFrame` for optimal rendering performance.
 
+<!--links:start-->
+[npm-version-badge]: https://img.shields.io/npm/v/@use-raf/state.svg
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@use-raf/state.svg
+[bundle-size-badge]: https://img.shields.io/bundlephobia/minzip/@use-raf/state
+[bundlephobia-link]: https://bundlephobia.com/package/@use-raf/state
+[types-badge]: https://img.shields.io/npm/types/@use-raf/state
+[npm-link]: https://www.npmjs.com/package/@use-raf/state
+[license-badge]: https://img.shields.io/npm/l/@use-raf/state.svg
+[license-link]: https://github.com/einouqo/use-raf/blob/main/LICENSE
+[codspeed-link]: https://codspeed.io/einouqo/use-raf
+<!--links:end-->
+
 ## Installation
 
 ```bash
@@ -60,7 +78,7 @@ const Demo = () => {
 **Note:** When multiple updater functions are called between frames (e.g., `setState(prev => prev + 1)` three times), `@use-raf/state` correctly chains them, resulting in `3`, while other implementations (`@shined/react-use`, `react-use`, `@reactuses/core`) only apply the last update, resulting in `1`. See [the trial test case](./src/state.test.ts#L367-L410):
 
 ```bash
-bun run test:trial
+pnpm run test:trial
 ```
 
 Another example illustrating this behavior:
@@ -132,11 +150,7 @@ Benchmarked against similar hooks from popular libraries. While `react-use` lead
 **Running benchmarks:**
 
 ```bash
-bun run bench
+pnpm run bench
 ```
 
 **Performance regression tracking:** benchmark results are continuously monitored via [CodSpeed][codspeed-link] to detect performance regressions.
-
-<!--links:start-->
-[codspeed-link]: https://codspeed.io/einouqo/use-raf
-<!--links:end-->

package/package.json

@@ -1,21 +1,14 @@
 {
   "name": "@use-raf/state",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "description": "React frame-synchronized state hook",
   "type": "module",
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.ts"
-  },
-  "publishConfig": {
-    "main": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "exports": {
-      ".": {
-        "types": "./dist/index.d.ts",
-        "import": "./dist/index.js"
-      }
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     }
   },
   "files": [
@@ -34,22 +27,11 @@
     "animation",
     "schedule"
   ],
-  "scripts": {
-    "build": "tsup",
-    "lint": "biome check",
-    "lint:fix": "biome check --write",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:trial": "TRIAL=true vitest run",
-    "bench": "vitest bench --run --no-file-parallelism --sequence.shuffle",
-    "bench:watch": "vitest bench --no-file-parallelism --sequence.shuffle",
-    "bench:regress": "vitest bench --run -t '#regress' --no-file-parallelism"
-  },
   "peerDependencies": {
     "react": ">=16.14"
   },
   "dependencies": {
-    "@use-raf/skd": "workspace:*"
+    "@use-raf/skd": "1.0.0"
   },
   "devDependencies": {
     "@reactuses/core": "^6.1.8",
@@ -65,5 +47,16 @@
   "bugs": {
     "url": "https://github.com/einouqo/use-raf/issues"
   },
-  "license": "MIT"
-}
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup",
+    "lint": "biome check",
+    "lint:fix": "biome check --write",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:trial": "TRIAL=true vitest run",
+    "bench": "vitest bench --run --no-file-parallelism --sequence.shuffle",
+    "bench:watch": "vitest bench --no-file-parallelism --sequence.shuffle",
+    "bench:regress": "vitest bench --run -t '#regress' --no-file-parallelism"
+  }
+}