@kreavoks/kreaui 0.0.1 → 0.0.2

package/README.md

@@ -1,49 +1,60 @@
-# Starlight Starter Kit: Basics
+# KreaUI Component Library
 
-[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+Modern, clean, and highly customizable Vue 3 component library built with Tailwind CSS for Kreavoks Digital projects.
 
-```
-npm create astro@latest -- --template starlight
-```
+## 🚀 Features
+- **Vue 3 & TypeScript**: Native Vue 3 components with full type support.
+- **Tailwind CSS Integration**: Fully integrated with official Kreavoks Design Tokens.
+- **Dark Mode Ready**: Built-in support for dark mode.
+- **Lightweight & Modular**: Component structure built for optimal bundle size.
 
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+---
 
-## 🚀 Project Structure
+## 📦 Installation
 
-Inside of your Astro + Starlight project, you'll see the following folders and files:
+Install KreaUI package via npm:
 
-```
-.
-├── public/
-├── src/
-│   ├── assets/
-│   ├── content/
-│   │   └── docs/
-│   └── content.config.ts
-├── astro.config.mjs
-├── package.json
-└── tsconfig.json
+```bash
+npm install @kreavoks/kreaui
 ```
 
-Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+---
 
-Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+## ⚡ Quick Start
 
-Static assets, like favicons, can be placed in the `public/` directory.
+### 1. Import Components & Style
+Import the components and CSS styles into your Vue file:
 
-## 🧞 Commands
+```vue
+<script setup>
+import { Button, Badge } from '@kreavoks/kreaui';
+import '@kreavoks/kreaui/style.css';
+</script>
 
-All commands are run from the root of the project, from a terminal:
+<template>
+  <Button variant="primary">Hello KreaUI</Button>
+  <Badge type="notification">5</Badge>
+</template>
+```
 
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `npm install`             | Installs dependencies                            |
-| `npm run dev`             | Starts local dev server at `localhost:4321`      |
-| `npm run build`           | Build your production site to `./dist/`          |
-| `npm run preview`         | Preview your build locally, before deploying     |
-| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI                     |
+### 2. Register Tailwind CSS Plugin
+To enable KreaUI's custom colors (e.g. `bg-kv-primary`) and corner radius values, add the KreaUI plugin to your `tailwind.config.js`:
+
+```javascript
+import { kreauiPlugin } from '@kreavoks/kreaui';
+
+export default {
+  content: [
+    "./node_modules/@kreavoks/kreaui/dist/**/*.js",
+    "./src/**/*.{html,js,vue,ts}"
+  ],
+  plugins: [
+    kreauiPlugin
+  ],
+}
+```
 
-## 👀 Want to learn more?
+---
 
-Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
+## 📄 License
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kreavoks/kreaui",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "./lib/kreaui.umd.js",
   "module": "./lib/kreaui.es.js",
   "exports": {
@@ -22,7 +22,8 @@
     "preview": "astro preview",
     "astro": "astro"
   },
-  "dependencies": {
+  "dependencies": {},
+  "devDependencies": {
     "@astrojs/react": "^6.0.0",
     "@astrojs/starlight": "^0.41.1",
     "@astrojs/vue": "^7.0.0",