state-in-url 3.0.3 → 3.0.5

package/README.md

@@ -3,7 +3,14 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 <div align="center">
   <img src="/assets/Logo_big.png?raw=true" alt="state-in-url logo"/>
 
-  <div>Easily share complex state between unrelated React components, with IDE autocomplete and TS validation. Without any hasssle or boilerplate. </div>
+  <div><h2>Easily share complex state objects between unrelated React components, preserve types and structure, with TS validation. Without any hasssle or boilerplate.</h2></div>
+
+</div>
+
+<hr />
+
+<div align="center">
+<a href="https://github.com/asmyshlyaev177/state-in-url/blob/master/Limits.md"  target="_blank">URI size limitation, <b>up to 12KB</b> is safe</a>
 </div>
 
 <div align="center">
@@ -26,7 +33,7 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 ![Demo-gif](https://github.com/asmyshlyaev177/state-in-url/blob/master/assets/Demo-gif.gif)
 
 <a href="https://state-in-url-asmyshlyaev177.vercel.app/" target="_blank">DEMO</a> |
-<a href="https://state-in-url.netlify.app/" target="_blank">DEMO2</a> |
+<a href="https://state-in-url.netlify.app/" target="_blank">DEMO2</a>
 
 <hr />
 
@@ -42,7 +49,7 @@ Share if it useful for you.
 
   </div>
 
-## Why use state-in-url?
+# Why use state-in-url?
 
 `state-in-url` Simple state management with optional URL sync. Good for implementing deep links. Share complex states between unrelated React components, TS-friendly, NextJS compatible. Most of users don't care about URL, so, can use it to store your app state.
 
@@ -103,7 +110,7 @@ pnpm add state-in-url
 In `tsconfig.json` in `compilerOptions` set `"moduleResolution": "Bundler"`, or`"moduleResolution": "Node16"`, or `"moduleResolution": "NodeNext"`.
 Possibly need to set `"module": "ES2022"`, or `"module": "ESNext"`
 
-# useUrlState
+## useUrlState
 
 `useUrlState` is a custom React hook for Next.js/React-Router applications that make communication between client components easy. It allows you to share any complex state and sync it with the URL search parameters, providing a way to persist state across page reloads and share application state via URLs.
 
@@ -353,7 +360,6 @@ API is same as for Next.js version, except can pass options from [NavigateOption
 
 [Docs](packages/urlstate/react-router/useUrlState#api)
 
-
 ### Example
 
 ```typescript
@@ -487,7 +493,6 @@ function SettingsComponent() {
 
 See [Contributing doc](CONTRIBUTING.md)
 
-
 ## Roadmap
 
 - [x] hook for `Next.js`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "state-in-url",
-  "version": "3.0.3",
-  "description": "Library to store complex state in browser URL, includes hook for NextJS, hook for pure React, and low level helpers.",
+  "version": "3.0.5",
+  "description": "Easily share complex state objects between unrelated React components, preserve types and structure, with TS validation. Deep links and url state synchronization wthout any hasssle or boilerplate.",
   "homepage": "https://state-in-url-asmyshlyaev177.vercel.app",
   "keywords": [
     "front-end",
@@ -9,20 +9,23 @@
     "state management",
     "deep links",
     "deep linking",
-    "Next.js",
+    "url synchronization",
     "useUrlState",
+    "state in url",
     "client components communication",
     "signals alternative",
     "query string",
     "search params",
+    "query params",
     "typescript",
-    "react.js",
     "workflow",
     "javascript",
     "hooks",
+    "react.js",
     "reactjs",
     "react",
-    "NextJS"
+    "NextJS",
+    "Next.js"
   ],
   "repository": {
     "type": "git",