Skip to content

Commit c2299b6

Browse files
committed
docs: add active development notice to documentation and update package description
1 parent a7f03fa commit c2299b6

File tree

7 files changed

+24
-1
lines changed

7 files changed

+24
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
[![CI](https://github.com/iamsomraj/vue-qs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/iamsomraj/vue-qs/actions/workflows/ci.yml) [![npm version](https://img.shields.io/npm/v/vue-qs.svg)](https://www.npmjs.com/package/vue-qs) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
66

7+
> Active Development Notice
8+
> This library is currently in active development. APIs may change significantly between versions. Please use with caution and expect breaking changes.
9+
710
Docs: https://iamsomraj.github.io/vue-qs/ · 中文文档: https://iamsomraj.github.io/vue-qs/zh/
811

912
Type‑safe, reactive URL query params for Vue 3. Inspired by nuqs (React) but built for the Vue Composition API.

docs/api/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
# vue-qs v0.1.16
66

7+
::: warning Active Development Notice
8+
This library is currently in active development. APIs may change significantly between versions. Please use with caution and expect breaking changes.
9+
:::
10+
711
## Namespaces
812

913
- [serializers](vue-qs/namespaces/serializers/README.md)

docs/guide/getting-started.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Getting Started
22

3+
::: warning Active Development Notice
4+
This library is currently in active development. APIs may change significantly between versions. Please use with caution and expect breaking changes.
5+
:::
6+
37
**Type‑safe, reactive URL query params for Vue** - Keep important UI state (search text, page number, filters) in the URL, not hidden in component memory. `vue-qs` makes this easy with two composables and modern error handling.
48

59
## Install

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ features:
1919
- title: Rich Serializers
2020
details: Built-in codecs for strings, numbers, booleans, dates, JSON, arrays, and enums with custom serialization support.
2121
---
22+
23+
::: warning Active Development Notice
24+
This library is currently in active development. APIs may change significantly between versions. Please use with caution and expect breaking changes.
25+
:::

docs/zh/guide/getting-started.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# 快速开始
22

3+
::: warning 积极开发提醒
4+
该库目前正在积极开发中,**尚未准备好用于生产环境**。API 可能在版本之间发生重大变化。请谨慎使用,并预期会有破坏性更改。
5+
:::
6+
37
**Type‑safe, reactive URL query params for Vue** - 把常用的界面状态(搜索词、页码、筛选条件)放进 URL,这样刷新、分享、前进/后退都能保持。`vue-qs` 提供两个组合式函数和现代化错误处理来轻松实现这些功能。
48

59
## 安装

docs/zh/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ features:
1919
- title: 丰富的序列化器
2020
details: 内置字符串、数字、布尔值、日期、JSON、数组和枚举编解码器,支持自定义序列化。
2121
---
22+
23+
::: warning 积极开发提醒
24+
该库目前正在积极开发中,**尚未准备好用于生产环境**。API 可能在版本之间发生重大变化。请谨慎使用,并预期会有破坏性更改。
25+
:::

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "vue-qs",
33
"version": "0.1.16",
4-
"description": "Type‑safe, reactive URL query params for Vue",
4+
"description": "Type‑safe, reactive URL query params for Vue (in development)",
55
"license": "MIT",
66
"author": "Somraj Mukherjee",
77
"type": "module",

0 commit comments

Comments
 (0)