lovelymaid 1.0.8 → 1.1.0

package/README.md

@@ -0,0 +1,38 @@
+# Usage
+
+## Step 1: Import CSS in your entry file
+
+Add the following import statement **at the very beginning** of your main entry file (usually `main.js` or `main.ts`):
+
+```javascript
+import 'lovelymaid/dist/lovelymaid.css'
+```
+
+**Important:** Make sure this import comes **before any other style imports** in your project. This allows your custom styles to override the component library's default styles.
+
+Example `main.js`:
+```javascript
+// main.js or main.ts
+import 'lovelymaid/dist/lovelymaid.css'  // ← MUST be first!
+import './your-own-styles.css'
+import { createApp } from 'vue'
+import App from './App.vue'
+
+createApp(App).mount('#app')
+```
+
+## Step 2: Use components in any Vue component
+
+Import and use LovelyMaid components directly in your Vue components:
+
+```vue
+<script setup>
+import { SideBar } from 'lovelymaid'
+</script>
+
+<template>
+  <SideBar :visible="true">
+    Sidebar Content
+  </SideBar>
+</template>
+```

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "lovelymaid",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "A library of components based on vue3 that mimics the style of iOS 26",
+  "license": "MIT",
+  "keywords": [
+    "vue3",
+    "components",
+    "ios26",
+    "lovelymaid"
+  ],
   "main": "dist/lovelymaid.umd.js",
   "module": "dist/lovelymaid.es.js",
   "types": "dist/index.d.ts",
@@ -16,6 +23,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
+    "typescript": "^5.9.3",
     "vue": "^3.5.22"
   },
   "devDependencies": {