From 5e4fa25fc48190b73190716bdf95d4e33c6447d1 Mon Sep 17 00:00:00 2001 From: Grzegorz Kucmierz Date: Tue, 3 Mar 2026 09:24:00 +0000 Subject: [PATCH] chore: prepare for npm publishing as @gkucmierz/bitcoin-logo --- .gitea/workflows/npm-publish.yaml | 22 +++++++++++++ LICENSE | 21 ++++++++++++ README.md | 53 +++++++++++++++++++++++++++++-- package.json | 24 ++++++++++---- src/index.js | 4 +++ vite.config.js | 16 ++++++++++ 6 files changed, 131 insertions(+), 9 deletions(-) create mode 100644 .gitea/workflows/npm-publish.yaml create mode 100644 LICENSE create mode 100644 src/index.js diff --git a/.gitea/workflows/npm-publish.yaml b/.gitea/workflows/npm-publish.yaml new file mode 100644 index 0000000..b0ecbf3 --- /dev/null +++ b/.gitea/workflows/npm-publish.yaml @@ -0,0 +1,22 @@ +name: npm-publish + +on: + push: + tags: + - 'v*' + workflow_dispatch: + +jobs: + publish: + runs-on: self-hosted + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: '20.x' + registry-url: 'https://registry.npmjs.org' + - run: npm ci + - run: npm run build + - run: npm publish --access public + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6ea5037 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Grzegorz Kucmierz + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 1511959..f12c148 100644 --- a/README.md +++ b/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 ` + + +``` + +### 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 diff --git a/package.json b/package.json index 80fc565..a3dce39 100644 --- a/package.json +++ b/package.json @@ -1,21 +1,33 @@ { - "name": "bitcoin-logo", - "private": true, + "name": "@gkucmierz/bitcoin-logo", "version": "1.0.0", "description": "Premium 3D SVG rotating Bitcoin logo", "author": "Grzegorz Kucmierz", "license": "MIT", "type": "module", + "main": "./dist/bitcoin-logo.umd.cjs", + "module": "./dist/bitcoin-logo.js", + "exports": { + ".": { + "import": "./dist/bitcoin-logo.js", + "require": "./dist/bitcoin-logo.umd.cjs" + }, + "./style.css": "./dist/bitcoin-logo.css" + }, + "files": [ + "dist" + ], "scripts": { "dev": "vite", "build": "vite build", "preview": "vite preview" }, - "dependencies": { - "vue": "^3.5.25" + "peerDependencies": { + "vue": "^3.0.0" }, "devDependencies": { "@vitejs/plugin-vue": "^6.0.2", - "vite": "^7.3.1" + "vite": "^7.3.1", + "vue": "^3.5.25" } -} \ No newline at end of file +} diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..f1e8fdc --- /dev/null +++ b/src/index.js @@ -0,0 +1,4 @@ +import BitcoinLogo from './components/BitcoinLogo.vue' + +export { BitcoinLogo } +export default BitcoinLogo diff --git a/vite.config.js b/vite.config.js index 0d2fd46..635446a 100644 --- a/vite.config.js +++ b/vite.config.js @@ -1,8 +1,24 @@ import { defineConfig } from 'vite' import vue from '@vitejs/plugin-vue' +import { resolve } from 'path' export default defineConfig({ plugins: [vue()], + build: { + lib: { + entry: resolve(__dirname, 'src/index.js'), + name: 'BitcoinLogo', + fileName: 'bitcoin-logo', + }, + rollupOptions: { + external: ['vue'], + output: { + globals: { + vue: 'Vue', + }, + }, + }, + }, server: { host: true, allowedHosts: true,