@curiousvlxd/linkedin-badge-renderer 0.1.25 → 0.1.26

package/README.md

@@ -8,14 +8,36 @@
   />
 </p>
 
+<p align="center">
+  <a href="https://github.com/curiousvlxd/linkedin-badge-renderer/actions/workflows/npm-publish.yml">
+    <img src="https://github.com/curiousvlxd/linkedin-badge-renderer/actions/workflows/npm-publish.yml/badge.svg" />
+  </a>
+
+  <a href="https://www.npmjs.com/package/@curiousvlxd/linkedin-badge-renderer">
+    <img src="https://img.shields.io/npm/v/@curiousvlxd/linkedin-badge-renderer?color=cb3837&logo=npm" />
+  </a>
+
+  <a href="https://github.com/curiousvlxd/linkedin-badge-renderer/pkgs/npm/linkedin-badge-renderer">
+    <img src="https://img.shields.io/badge/GitHub%20Packages-published-1f6feb?logo=github" />
+  </a>
+</p>
+
 <div align="center" style="display: flex; flex-wrap: wrap; justify-content: center; gap: 10px;">
-  <a href="https://www.linkedin.com/in/vladtimchenko/" target="_blank" style="transition: transform .15s ease;">
-    <img style="width: 39%;" src="https://raw.githubusercontent.com/curiousvlxd/linkedin-badge-renderer/main/assets/example-dark.svg" />
+
+  <a href="https://www.linkedin.com/in/vladtimchenko/">
+    <img
+      style="width: 49%;"
+      src="https://raw.githubusercontent.com/curiousvlxd/linkedin-badge-renderer/main/assets/example-dark.svg"
+    />
   </a>
 
-  <a href="https://www.linkedin.com/in/vladtimchenko/" target="_blank" style="transition: transform .15s ease;">
-    <img style="width: 39%;" src="https://raw.githubusercontent.com/curiousvlxd/linkedin-badge-renderer/main/assets/example-light.svg" />
+  <a href="https://www.linkedin.com/in/vladtimchenko/">
+    <img
+      style="width: 49%;"
+      src="https://raw.githubusercontent.com/curiousvlxd/linkedin-badge-renderer/main/assets/example-light.svg"
+    />
   </a>
+
 </div>
 
 A CLI tool for generating LinkedIn profile badges in SVG, PNG, JPEG, or PDF format.
@@ -161,3 +183,7 @@ Embed the badge in any README:
 ```
 
 ---
+
+## License
+
+MIT © Vlad Timchenko

package/README.npm.md

@@ -0,0 +1,164 @@
+# linkedin-badge-renderer
+
+<p align="center">
+  <img
+    src="https://raw.githubusercontent.com/curiousvlxd/linkedin-badge-renderer/main/assets/logo.png"
+    width="200"
+    alt="LinkedIn Badge Renderer Logo"
+  />
+</p>
+
+<p align="center">
+  <a href="https://www.linkedin.com/in/vladtimchenko/">
+    <img src="https://raw.githubusercontent.com/curiousvlxd/linkedin-badge-renderer/main/assets/example-dark.svg" width="380" />
+    <img src="https://raw.githubusercontent.com/curiousvlxd/linkedin-badge-renderer/main/assets/example-light.svg" width="380" />
+  </a>
+</p>
+
+A CLI tool for generating LinkedIn profile badges in SVG, PNG, JPEG, or PDF format.
+
+Renders the official LinkedIn badge using Playwright and exports pixel-perfect assets for websites, resumes, and portfolios.
+
+---
+
+## Features
+
+- Generate badges as SVG, PNG, JPEG, or PDF
+- Pixel-perfect rendering via Chromium
+- Transparent background for images
+- No manual screenshots
+- Works in CI and GitHub Actions
+- Cross-platform (Windows, macOS, Linux)
+
+---
+
+## Installation
+
+Install globally from npm:
+
+```bash
+npm install -g @curiousvlxd/linkedin-badge-renderer
+npx playwright install chromium
+```
+
+Or clone the repository:
+
+```bash
+git clone https://github.com/curiousvlxd/linkedin-badge-renderer.git
+cd linkedin-badge-renderer
+npm install
+npx playwright install chromium
+```
+
+---
+
+## Usage
+
+Basic example:
+
+```bash
+linkedin-badge --handle vladtimchenko
+```
+
+Generate SVG (default):
+
+```bash
+linkedin-badge --handle vladtimchenko --format svg
+```
+
+Generate PNG:
+
+```bash
+linkedin-badge --handle vladtimchenko --format png
+```
+
+Custom output path:
+
+```bash
+linkedin-badge --handle vladtimchenko --out dist/badge.svg
+```
+
+Dark theme, vertical layout:
+
+```bash
+linkedin-badge --handle vladtimchenko --theme dark --orientation vertical
+```
+
+---
+
+## Available Options
+
+| Option | Description | Default | Values |
+|--------|-------------|---------|--------|
+| --handle | LinkedIn handle | Required | Any valid handle |
+| --format | Output format | svg | svg, png, jpeg, pdf |
+| --out | Output path | dist/linkedin-badge.svg | Any path |
+| --theme | Badge theme | light | light, dark |
+| --size | Badge size | large | small, medium, large |
+| --locale | LinkedIn locale | en_US | Any locale |
+| --orientation | Layout | HORIZONTAL | HORIZONTAL, VERTICAL |
+| --pad | Padding (px) | 20 | Integer |
+
+---
+
+## GitHub Actions Integration
+
+You can automatically generate and publish your badge using GitHub Actions.
+
+Example workflow:
+
+```yaml
+name: Export LinkedIn Badge
+
+on:
+  schedule:
+    - cron: "15 2 * * *"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  badge:
+    uses: curiousvlxd/linkedin-badge-renderer/.github/workflows/export.yml@main
+    with:
+      handle: "vladtimchenko"
+      format: "svg"
+      out: "linkedin-badge.svg"
+      theme: "dark"
+      size: "large"
+      locale: "en_US"
+      orientation: "HORIZONTAL"
+      pad: 20
+      output_branch: "output"
+      commit_message: "chore: update linkedin badge"
+```
+
+After the workflow runs, the badge will be available at:
+
+```https://raw.githubusercontent.com/<USERNAME>/<REPOSITORY>/<BRANCH>/<FILE_NAME>```
+
+---
+
+## Using in README
+
+Real-world example:
+https://github.com/curiousvlxd/curiousvlxd/blob/main/README.md
+
+Embed the badge in any README:
+
+```md
+<a href="https://www.linkedin.com/in/vladtimchenko/" target="_blank">
+  <img
+    src="https://raw.githubusercontent.com/curiousvlxd/curiousvlxd/output/linkedin-badge.svg"
+    width="500"
+    alt="LinkedIn Profile"
+  />
+</a>
+```
+
+---
+
+## License
+
+MIT © Vlad Timchenko

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@curiousvlxd/linkedin-badge-renderer",
-  "version": "0.1.25",
+  "version": "0.1.26",
   "description": "CLI tool for generating LinkedIn profile badges in SVG, PNG, JPEG, and PDF formats using Playwright.",
+  "readme": "README.npm.md",
   "type": "module",
   "bin": {
     "linkedin-badge": "src/cli.mjs"