@yiin/reactive-proxy-state 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yiin
+
+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,6 +1,6 @@
 # Reactive Proxy State
 
-[![npm version](https://badge.fury.io/js/yiin/reactive-proxy-state.svg)](https://badge.fury.io/js/yiin/reactive-proxy-state) <!-- Replace yiin/reactive-proxy-state -->
+[![npm version](https://badge.fury.io/js/%40yiin%2Freactive-proxy-state.svg)](https://badge.fury.io/js/%40yiin%2Freactive-proxy-state) <!-- Replace @yiin/reactive-proxy-state -->
 
 A simple, standalone reactivity library inspired by Vue 3's reactivity system, designed for use outside of Vue, particularly in server-side contexts or for data synchronization tasks. It uses JavaScript Proxies to track changes in plain objects, Arrays, Maps, and Sets.
 
@@ -9,9 +9,9 @@ A simple, standalone reactivity library inspired by Vue 3's reactivity system, d
 ## Installation
 
 ```bash
-bun add yiin/reactive-proxy-state
-# or npm install yiin/reactive-proxy-state
-# or yarn add yiin/reactive-proxy-state
+bun add @yiin/reactive-proxy-state
+# or npm install @yiin/reactive-proxy-state
+# or yarn add @yiin/reactive-proxy-state
 ```
 
 ## Core Concepts
@@ -27,7 +27,7 @@ bun add yiin/reactive-proxy-state
 Creates a reactive proxy for the given object, Array, Map, or Set. Nested objects/collections are also recursively wrapped.
 
 ```typescript
-import { wrapState } from 'yiin/reactive-proxy-state';
+import { wrapState } from '@yiin/reactive-proxy-state';
 
 const state = wrapState({
   count: 0,
@@ -52,7 +52,7 @@ Creates a reactive "reference" object for any value type (primitive or object).
 **Note:** If a plain object is passed to `ref`, the object *itself* is not made deeply reactive. Only assignment to the `.value` property is tracked. Use `wrapState` for deep object reactivity.
 
 ```typescript
-import { ref, watchEffect, isRef, unref } from 'yiin/reactive-proxy-state';
+import { ref, watchEffect, isRef, unref } from '@yiin/reactive-proxy-state';
 
 // Ref for a primitive
 const count = ref(0);
@@ -96,7 +96,7 @@ Creates a computed property based on a getter function. The getter tracks reacti
 Computed refs are read-only.
 
 ```typescript
-import { ref, computed, watchEffect, isComputed } from 'yiin/reactive-proxy-state';
+import { ref, computed, watchEffect, isComputed } from '@yiin/reactive-proxy-state';
 
 const firstName = ref('John');
 const lastName = ref('Doe');
@@ -157,7 +157,7 @@ Runs a function immediately, tracks its reactive dependencies, and re-runs it sy
 *   `onTrigger?(event)`: Debug hook called when the effect is triggered by a mutation.
 
 ```typescript
-import { wrapState, ref, watchEffect } from 'yiin/reactive-proxy-state';
+import { wrapState, ref, watchEffect } from '@yiin/reactive-proxy-state';
 
 // ... existing watchEffect example using wrapState ...
 
@@ -182,7 +182,7 @@ Watches a specific reactive source (either a getter function, a direct reactive
 *   `deep?: boolean`: If `true`, deeply traverses the source for dependency tracking and uses deep comparison logic. **Defaults to `true`**. Set to `false` for shallow watching (only triggers on direct assignment or identity change).
 
 ```typescript
-import { wrapState, ref, watch } from 'yiin/reactive-proxy-state';
+import { wrapState, ref, watch } from '@yiin/reactive-proxy-state';
 
 // ... existing watch examples using wrapState ...
 
@@ -209,7 +209,7 @@ doubleCount.value = 110; // Output: Double changed from 200 to 220
 `wrapState` automatically handles Arrays, Maps, and Sets. Mutations via standard methods (`push`, `pop`, `splice`, `set`, `delete`, `add`, `clear`, etc.) are reactive and will trigger effects that depend on the collection or its contents (if watched deeply).
 
 ```typescript
-import { wrapState, watchEffect } from 'yiin/reactive-proxy-state';
+import { wrapState, watchEffect } from '@yiin/reactive-proxy-state';
 
 const state = wrapState({
   list: [1, 2],
@@ -227,7 +227,3 @@ state.tags.add('important');   // Output: Tags: important
 state.data.delete('foo');      // Output: Data has "foo": false
 state.tags.add('urgent');      // Output: Tags: important, urgent
 ```
-
-## License
-
-<!-- Add your license information here, e.g., MIT --> 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@yiin/reactive-proxy-state",
   "private": false,
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A simple, standalone reactivity library using Proxies",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,4 +48,4 @@
     "bun-types": "^1.2.8",
     "typescript": "^5.0.4"
   }
-}
+}