vue-router-query-sync 0.0.13 → 1.0.0

package/README.md

@@ -16,14 +16,22 @@
 
 - Changes in your store update the URL query.
 - Changes in the URL query update your store.
-- Batched updates to avoid excessive router.replace calls.
+- Batched updates prevent excessive `router.replace` calls.
 
 ---
 
+## 💡 Why use this plugin?
+
+- 🔄 Keeps your app state and URL perfectly in sync — no more manual watchers or `router.replace` logic.
+- 🧠 Works with **Pinia**, **local refs**, or any reactive source.
+- 🧩 Handles multiple query keys and isolated contexts safely.
+- ⚙️ Fully typed with TypeScript and designed for Vue 3’s Composition API.
+- 🚀 Tiny footprint — optimized for production.
+
 ## ✅ Requirements
 
-- Vue 3 (`vue@^3.3.13`)
-- Vue Router 4 (`vue-router@^4.0.3`)
+- Vue 3
+- Vue Router 4
 
 ---
 
@@ -63,7 +71,8 @@ createApp(App)
 
 ## 🧩 Basic Usage
 
-Sync a value with a query param named `tab`:
+- You can use `useQuerySync` several times in one component.
+- Sync a value with a query param named `tab`:
 
 ```ts
 import { useQuerySync } from 'vue-router-query-sync'

package/dist/composables/useQuerySync.d.ts

@@ -1,17 +1,17 @@
 import { QuerySyncOptions } from '../types';
 /**
- * Синхронизирует значение из стора с query-параметром в адресной строке
+ * Synchronizes a store value with a query parameter in the URL.
  *
- * @param key - имя параметра в query, например "tab"
- * @param get - функция, возвращающая текущее значение из стора
- * @param set - функция, устанавливающая значение в стор
- * @param options.deps - список зависимостей, чтобы синхронизировать только после их изменения
- * @param options.context - конекст использования query-параметра, обязателен, если на странице нессколько одинаковых query-параметра
+ * @param key - The name of the query parameter, e.g. "tab".
+ * @param get - A function that returns the current value from the store.
+ * @param set - A function that updates the value in the store.
+ * @param options.deps - A list of reactive dependencies that must change before synchronization occurs.
+ * @param options.context - A unique context identifier, required when multiple instances use the same query key on the same page.
  *
- * ⚠️ Важно:
- * Если на одной странице может быть несколько компонентов с одинаковыми query-ключами —
- * обязательно передавайте уникальный `context`, чтобы не было конфликтов.
- * Или всегда использовать уникальные ключи (например вместо "page" - "usersPage").
+ * ⚠️ Important:
+ * If multiple components on the same page use the same query key,
+ * you must provide a unique `context` to prevent conflicts.
+ * Alternatively, always use unique query keys (for example, instead of "page", use "usersPage").
  */
 export declare function useQuerySync<T extends string | number>(key: string, get: () => T | null, set: (val: T) => void, options?: QuerySyncOptions): void;
 //# sourceMappingURL=useQuerySync.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-router-query-sync",
-  "version": "0.0.13",
+  "version": "1.0.0",
   "description": "Vue composable for syncing router query params with store",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -20,12 +20,16 @@
   ],
   "keywords": [
     "vue",
+    "vue3",
+    "vue plugin",
     "router",
     "query",
     "sync",
     "pinia",
     "store",
-    "composable"
+    "composable",
+    "router query",
+    "query sync"
   ],
   "author": "Ivan Chikachev <ivan-chikachev@mail.ru>",
   "license": "MIT",