scq-vue 1.0.8 → 1.0.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 shichangqi
+
+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,160 +1,9 @@
 # scq-vue
 
-Vue 3 component library with Button, Input and ChatMessage.
+A lightweight Vue 3 component library with Button, Input, and ChatMessage.
 
-## Install
+### Online Demo
 
-```bash
-npm install scq-vue
-yarn add scq-vue
-pnpm add scq-vue
-```
+See full usage examples, props, and interaction demos here:
 
-## Usage
-
-### Global install
-
-```ts
-import { createApp } from 'vue'
-import App from './App.vue'
-import ScqVue from 'scq-vue'
-import 'scq-vue/style.css'
-
-createApp(App).use(ScqVue).mount('#app')
-```
-
-After global install, you can use component tags directly in templates:
-
-```vue
-<template>
-	<scq-button type="primary">Primary</scq-button>
-	<scq-input v-model="value" placeholder="Please input" />
-	<scq-chat-message :message="message" role="ai" :timestamp="Date.now()" />
-</template>
-```
-
-Notes:
-- Use prefixed tag names only: `scq-button`, `scq-input`, `scq-chat-message`
-
-### On-demand import
-
-```ts
-import { createApp } from 'vue'
-import App from './App.vue'
-import { ScqButton, ScqInput, ScqChatMessage } from 'scq-vue'
-import 'scq-vue/style.css'
-
-const app = createApp(App)
-app.use(ScqButton)
-app.use(ScqInput)
-app.use(ScqChatMessage)
-app.mount('#app')
-```
-
-Then use in templates:
-
-```vue
-<template>
-	<scq-button>Default</scq-button>
-	<scq-input v-model="value" />
-	<scq-chat-message :message="message" role="user" :show-time="false" />
-</template>
-```
-
-### On-demand style import
-
-```ts
-import { ScqButton, ScqInput, ScqChatMessage } from 'scq-vue'
-import 'scq-vue/styles/button.css'
-import 'scq-vue/styles/input.css'
-import 'scq-vue/styles/chat-message.css'
-```
-
-## Components
-
-- Button
-- Input
-- ChatMessage
-
-## ChatMessage
-
-ChatMessage is designed for chat scenarios and supports API response data rendering directly.
-
-### Features
-
-- Supports plain text, JSON and Markdown content
-- Supports code highlighting (Markdown code blocks and JSON view)
-- Supports two message roles: AI and user
-- Supports configurable time display
-
-### Basic example
-
-```vue
-<template>
-	<scq-chat-message
-		:message="apiData"
-		role="ai"
-		content-type="auto"
-		:show-time="true"
-		:timestamp="Date.now()"
-	/>
-</template>
-
-<script setup lang="ts">
-const apiData = {
-	id: 'msg_001',
-	text: 'This is response data from API',
-	code: 'const x = 1',
-}
-</script>
-```
-
-### Props
-
-| Prop | Description | Type | Default |
-| --- | --- | --- | --- |
-| message | Message data from API | unknown | - |
-| role | Message role | `ai` \| `user` | `ai` |
-| contentType | Content type | `auto` \| `text` \| `markdown` \| `json` | `auto` |
-| showTime | Whether to display timestamp | boolean | true |
-| timestamp | Message time value | string \| number \| Date \| null | null |
-| timeFormatter | Custom time formatter | `(value) => string` | - |
-
-### Content type behavior
-
-- `auto`: detect JSON string / Markdown / plain text automatically
-- `text`: force plain text rendering
-- `markdown`: force Markdown rendering
-- `json`: force JSON pretty rendering
-
-<!-- ## Development
-
-```bash
-pnpm install
-pnpm dev
-pnpm build
-pnpm dev:play
-```
-
-## Publish
-
-1. Update version in package.json
-2. Build package
-
-```bash
-pnpm build
-```
-
-3. Login and publish
-
-```bash
-npm login
-npm publish
-```
-
-## Build output
-
-- dist/scq-vue.es.js
-- dist/scq-vue.umd.js
-- dist/style.css
-- dist/types -->
+[🔗 View Online Demo](https://shichangqi.github.io/scq-vue/)