@lovince/my-lit-library 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,111 @@
+# @lovince/my-lit-library
+
+Reusable Web Components built with Lit
+
+## Installation
+
+```bash
+npm install @lovince/my-lit-library
+```
+
+## Usage
+
+### Button Component
+
+The library includes a customizable button component with multiple variants.
+
+#### Import and Register
+
+```typescript
+import { Button, defineButton } from '@lovince/my-lit-library';
+
+// Register the component
+defineButton();
+```
+
+#### HTML Usage
+
+```html
+<!-- Default button -->
+<my-button>Click me</my-button>
+
+<!-- With variants -->
+<my-button variant="primary">Primary</my-button>
+<my-button variant="secondary">Secondary</my-button>
+<my-button variant="danger">Danger</my-button>
+<my-button variant="success">Success</my-button>
+<my-button variant="outline">Outline</my-button>
+```
+
+#### TypeScript Usage
+
+```typescript
+import { Button, ButtonVariant } from '@lovince/my-lit-library';
+
+// You can also use the type directly
+const variant: ButtonVariant = 'primary';
+```
+
+## Button Variants
+
+- **primary**: Blue background button (default)
+- **secondary**: Gray background button
+- **danger**: Red background button
+- **success**: Green background button
+- **outline**: Transparent with blue border
+
+## API Reference
+
+### Button Properties
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `variant` | `ButtonVariant` | `'primary'` | The visual style variant of the button |
+
+### ButtonVariant Type
+
+```typescript
+type ButtonVariant = 'primary' | 'secondary' | 'danger' | 'success' | 'outline';
+```
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Publishing
+
+The library follows semantic versioning:
+
+```bash
+# Bug fix
+npm version patch
+npm publish --access public
+
+# New feature
+npm version minor
+npm publish --access public
+
+# Breaking change
+npm version major
+npm publish --access public
+```
+
+## Browser Support
+
+This library supports all modern browsers that support [Web Components](https://caniuse.com/web-components) and [ES2022](https://caniuse.com/es2022).
+
+## Dependencies
+
+- **Lit**: ^3.0.0 (peer dependency)
+
+## License
+
+MIT
+
+## Versions
+
+See [npm versions](https://www.npmjs.com/package/@lovince/my-lit-library?activeTab=versions) for the complete version history.

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@lovince/my-lit-library",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Reusable Web Components built with Lit",
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "main": "./dist/index.js",
   "module": "./dist/index.js",