chore: prepare for npm publishing as @gkucmierz/bitcoin-logo

README.md

@@ -1,5 +1,52 @@
-# Vue 3 + Vite
+# @gkucmierz/bitcoin-logo
 
-This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+![NPM Version](https://img.shields.io/npm/v/@gkucmierz/bitcoin-logo)
+![License](https://img.shields.io/npm/l/@gkucmierz/bitcoin-logo)
 
-Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).
+A premium, customizable, and interactive 3D-style Bitcoin logo component for Vue 3.
+
+## 🚀 Features
+
+- **Interactive 3D Rotation**: Tilt and rotate the logo with mouse or touch.
+- **Inertia & Momentum**: Smooth rotation that continues after release.
+- **Customizable**: Control size, colors, and animation speed via props.
+- **Premium Aesthetics**: Clean SVG-based design with subtle gradients and shadows.
+
+## 📦 Installation
+
+```bash
+npm install @gkucmierz/bitcoin-logo
+```
+
+## 🛠 Usage
+
+```vue
+<script setup>
+import { BitcoinLogo } from '@gkucmierz/bitcoin-logo'
+import '@gkucmierz/bitcoin-logo/style.css'
+</script>
+
+<template>
+  <BitcoinLogo
+    :size="256"
+    symbolColor="#f7931a"
+    :inertia="true"
+  />
+</template>
+```
+
+### Props
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `size` | `Number` | `256` | The width and height of the logo in pixels. |
+| `symbolColor` | `String` | `'#f7931a'` | The color of the Bitcoin symbol. |
+| `autoRotate` | `Boolean` | `true` | Whether the logo should rotate automatically. |
+| `rotationDuration` | `Number` | `10` | Duration of one full rotation in seconds. |
+| `inertia` | `Boolean` | `true` | Enable inertia during manual interaction. |
+
+---
+
+## 📄 License
+
+MIT