@pixelium/web-vue 0.0.2-fix → 0.0.3-alpha

package/README.md

@@ -36,3 +36,45 @@ This project uses the following third-party assets:
 ---
 
 Thank you for using Pixelium Design.
+
+# Pixelium Design
+
+Pixelium Design – A pixel-art UI component library for Vue, built with TypeScript and Vite. Nostalgic aesthetics, tree-shakable components, dark and light themes, full type safety, ready to use right out of the box.
+
+[中文](./README.zh.md)
+
+[API Document](https://shika-works.github.io/pixelium-design/)
+
+## 🚀 Tech Stack
+
+- **Vue 3** – Full modern features ⚗️ including Composition API
+- **TypeScript** – Built on TS type system ✅ for out-of-the-box type safety
+- **Vite** – Lightning-fast cold start ⚡ + HMR 🔥, production build via Rollup 📦
+- **oxlint** – Blazing-fast Rust linter 🦀 to keep code quality & consistency ✨
+
+## 🎨 Features
+
+- **Pixel Aesthetics** – Retro pixel look 👾 with customizable resolution & palette 🎮
+- **OKlab Palette** – Theme generator 🌈 based on the OKlab color model for one-click custom palettes 🎨
+- **Tree-shakable** – Each component individually exported 🧩; unused code auto-dropped 🗑️
+- **Dark Mode** – Supports dark mode 🌙 following system preference or manual toggle 🔦
+
+## Documentation & Support
+
+- **Documentation**: [View the documentation](https://shika-works.github.io/pixelium-design/) to learn more about features and usage.
+- **Support**: Encounter any issues? Feel free to submit an [Issue](https://github.com/shika-works/pixelium-design/issues) or [Pull Request](https://github.com/shika-works/pixelium-design/pulls).
+- Please read the [Conventional Commits](./conventional-commits.md) specification before committing.
+
+## License
+
+Pixelium Design is released under the [MIT License](./LICENSE).  
+This project uses the following third-party assets:
+
+- **Font**: [Fusion Pixel](https://github.com/TakWolf/fusion-pixel-font), licensed under [SIL OFL 1.1](https://github.com/TakWolf/fusion-pixel-font/blob/master/LICENSE-OFL).
+- **Icons**:
+  - Icons from Pixel Icon Library by HackerNoon, [@hackernoon/pixel-icon-library](https://github.com/hackernoon/pixel-icon-library), licensed under [CC BY 4.0 International](https://pixeliconlibrary.com/license/).
+  - The open-source version of [pixelarticons](https://pixelarticons.com/). The open-source version is licensed under [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE).
+
+---
+
+Thank you for using Pixelium Design.

package/README.zh.md

@@ -1,6 +1,6 @@
 # Pixelium Design
 
-Pixelium Design – 基于 Vue 的像素风 UI 组件库，使用 TypeScript 与 Vite 构建。怀旧像素美学、可树摇组件、深浅主题，开箱即用，类型安全。
+Pixelium Design – 基于 Vue 的像素风 UI 组件库，使用 TypeScript 与 Vite 构建。怀旧像素美学、可树摇组件、深浅主题、开箱即用、类型安全。
 
 [English](./README.md)
 
@@ -24,14 +24,17 @@ Pixelium Design – 基于 Vue 的像素风 UI 组件库，使用 TypeScript 与
 
 - **文档**：[查看文档](https://shika-works.github.io/pixelium-design/)以了解更多功能和使用方法。
 - **支持**：在使用过程中遇到问题？欢迎提交 [Issue](https://github.com/shika-works/pixelium-design/issues) 或 [Pull Request](https://github.com/shika-works/pixelium-design/pulls)。
+- 提交前请阅读 [Conventional Commits](./conventional-commits.zh.md) 规范。
 
 ## 许可证
 
 Pixelium Design 使用[ MIT 许可证](./LICENSE)发布。  
 本项目使用的第三方资源：
 
-- **字体**：[Fusion Pixel](https://github.com/TakWolf/fusion-pixel-font)，采用 [SIL OFL 1.1](https://github.com/TakWolf/fusion-pixel-font/blob/master/LICENSE-OFL) 许可证
-- **图标**：Icons from Pixel Icon Library by HackerNoon，[pixel-icon-library](https://github.com/hackernoon/pixel-icon-library)，采用 [CC BY 4.0 International](https://pixeliconlibrary.com/license/) 许可证
+- **字体**：[Fusion Pixel](https://github.com/TakWolf/fusion-pixel-font)，采用 [SIL OFL 1.1](https://github.com/TakWolf/fusion-pixel-font/blob/master/LICENSE-OFL) 许可证。
+- **图标**：
+  - Icons from Pixel Icon Library by HackerNoon，[pixel-icon-library](https://github.com/hackernoon/pixel-icon-library)，采用 [CC BY 4.0 International](https://pixeliconlibrary.com/license/) 许可证。
+  - [pixelarticons](https://pixelarticons.com/) 的开源版本，开源版本许可证采用了 [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) 协议。
 
 ---
 

package/dist/font.css

@@ -1 +1 @@
-@font-face{font-family:Fusion Pixel Zh_hans;src:url("./fusion-pixel-12px-proportional-zh_hans.ttf.woff2") format("woff2")}
+@font-face{font-family:Fusion Pixel Zh_hans;src:url(./fusion-pixel-12px-proportional-zh_hans.ttf.woff2)format("woff2")}