From 50d8af5a1012e188f3d71ac8f1fc0fba1aab5357 Mon Sep 17 00:00:00 2001 From: Eric Fennis Date: Sun, 26 Apr 2026 10:43:49 +0200 Subject: [PATCH] docs(readme): Update readme files (#4320) * Update readme * Update vue readme file * Update readme files Co-authored-by: Copilot * Update badge paths * Update docs paths * Update docs/.vitepress/data/packageData.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update packages/svelte/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 26 ++++++++++----------- docs/.vitepress/data/packageData.json | 31 ++++++-------------------- packages/angular/README.md | 2 +- packages/astro/README.md | 2 +- packages/icons/README.md | 2 +- packages/lucide-angular/README.md | 2 +- packages/lucide-preact/README.md | 2 +- packages/lucide-react-native/README.md | 2 +- packages/lucide-react/README.md | 2 +- packages/lucide-solid/README.md | 2 +- packages/lucide-static/README.md | 2 +- packages/lucide-svelte/README.md | 3 ++- packages/lucide-vue-next/README.md | 2 +- packages/lucide/README.md | 2 +- packages/svelte/README.md | 5 +++-- packages/vue/README.md | 9 +++++++- 16 files changed, 44 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index ba4a99b22..1ba290da4 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@

- license + license figma installs - build status + build status discord chat

@@ -26,22 +26,22 @@ # Lucide -Lucide is an open-source icon library that provides 1000+ vector (svg) files for displaying icons and symbols in digital and non-digital projects. The library aims to make it easier for designers and developers to incorporate icons into their projects by providing several official [packages](https://lucide.dev/packages) to make it easier to use these icons in your project. +Lucide is an open-source icon library that provides 1600+ vector (svg) files for displaying icons and symbols in digital and non-digital projects. The library aims to make it easier for designers and developers to incorporate icons into their projects by providing several official [packages](https://lucide.dev/packages) to make it easier to use these icons in your project. ## Packages | Logo | Package | Version | Downloads | Links | | ---- | ------- | ------- | --------- | ----- | -| JS logo | **`lucide`** | [![npm](https://img.shields.io/npm/v/lucide)](https://www.npmjs.com/package/lucide) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide) | [Docs](https://lucide.dev/guide/packages/lucide) · [Source](./packages/lucide) | -| React logo | **`lucide-react`** | [![npm](https://img.shields.io/npm/v/lucide-react)](https://www.npmjs.com/package/lucide-react) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react) | [Docs](https://lucide.dev/guide/packages/lucide-react) · [Source](./packages/lucide-react) | -| Vue logo | **`lucide-vue-next`** | [![npm](https://img.shields.io/npm/v/lucide-vue-next)](https://www.npmjs.com/package/lucide-vue-next) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-vue-next) | [Docs](https://lucide.dev/guide/packages/lucide-vue-next) · [Source](./packages/lucide-vue-next) | -| Svelte logo | **`lucide-svelte`** | [![npm](https://img.shields.io/npm/v/lucide-svelte)](https://www.npmjs.com/package/lucide-svelte) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-svelte) | [Docs](https://lucide.dev/guide/packages/lucide-svelte) · [Source](./packages/lucide-svelte) | -| Solid logo | **`lucide-solid`** | [![npm](https://img.shields.io/npm/v/lucide-solid)](https://www.npmjs.com/package/lucide-solid) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-solid) | [Docs](https://lucide.dev/guide/packages/lucide-solid) · [Source](./packages/lucide-solid) | -| Preact logo | **`lucide-preact`** | [![npm](https://img.shields.io/npm/v/lucide-preact)](https://www.npmjs.com/package/lucide-preact) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-preact) | [Docs](https://lucide.dev/guide/packages/lucide-preact) · [Source](./packages/lucide-preact) | -| React Native logo | **`lucide-react-native`** | [![npm](https://img.shields.io/npm/v/lucide-react-native)](https://www.npmjs.com/package/lucide-react-native) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react-native) | [Docs](https://lucide.dev/guide/packages/lucide-react-native) · [Source](./packages/lucide-react-native) | -| Angular logo | **`lucide-angular`** | [![npm](https://img.shields.io/npm/v/lucide-angular)](https://www.npmjs.com/package/lucide-angular) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-angular) | [Docs](https://lucide.dev/guide/packages/lucide-angular) · [Source](./packages/lucide-angular) | -| Astro logo | **`@lucide/astro`** | [![npm](https://img.shields.io/npm/v/@lucide/astro)](https://www.npmjs.com/package/@lucide/astro) | ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/astro) | [Docs](https://lucide.dev/guide/packages/lucide-astro) · [Source](./packages/astro) | -| SVG logo | **`lucide-static`** | [![npm](https://img.shields.io/npm/v/lucide-static)](https://www.npmjs.com/package/lucide-static) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-static) | [Docs](https://lucide.dev/guide/packages/lucide-static) · [Source](./packages/lucide-static) | +| JS logo | **`lucide`** | [![npm](https://img.shields.io/npm/v/lucide)](https://www.npmjs.com/package/lucide) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide) | [Docs](https://lucide.dev/guide/lucide) · [Source](./packages/lucide) | +| React logo | **`lucide-react`** | [![npm](https://img.shields.io/npm/v/lucide-react)](https://www.npmjs.com/package/lucide-react) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react) | [Docs](https://lucide.dev/guide/react) · [Source](./packages/lucide-react) | +| Vue logo | **`@lucide/vue`** | [![npm](https://img.shields.io/npm/v/@lucide/vue)](https://www.npmjs.com/package/@lucide/vue) | ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/vue) | [Docs](https://lucide.dev/guide/vue) · [Source](./packages/vue) | +| Svelte logo | **`@lucide/svelte`** | [![npm](https://img.shields.io/npm/v/@lucide/svelte)](https://www.npmjs.com/package/@lucide/svelte) | ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/svelte) | [Docs](https://lucide.dev/guide/svelte) · [Source](./packages/@lucide/svelte) | +| Solid logo | **`lucide-solid`** | [![npm](https://img.shields.io/npm/v/lucide-solid)](https://www.npmjs.com/package/lucide-solid) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-solid) | [Docs](https://lucide.dev/guide/solid) · [Source](./packages/lucide-solid) | +| Preact logo | **`lucide-preact`** | [![npm](https://img.shields.io/npm/v/lucide-preact)](https://www.npmjs.com/package/lucide-preact) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-preact) | [Docs](https://lucide.dev/guide/preact) · [Source](./packages/lucide-preact) | +| React Native logo | **`lucide-react-native`** | [![npm](https://img.shields.io/npm/v/lucide-react-native)](https://www.npmjs.com/package/lucide-react-native) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react-native) | [Docs](https://lucide.dev/guide/react-native) · [Source](./packages/lucide-react-native) | +| Angular logo | **`@lucide/angular`** | [![npm](https://img.shields.io/npm/v/@lucide/angular)](https://www.npmjs.com/package/@lucide/angular) | ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/angular) | [Docs](https://lucide.dev/guide/angular) · [Source](./packages/angular) | +| Astro logo | **`@lucide/astro`** | [![npm](https://img.shields.io/npm/v/@lucide/astro)](https://www.npmjs.com/package/@lucide/astro) | ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/astro) | [Docs](https://lucide.dev/guide/astro) · [Source](./packages/astro) | +| SVG logo | **`lucide-static`** | [![npm](https://img.shields.io/npm/v/lucide-static)](https://www.npmjs.com/package/lucide-static) | ![NPM Downloads](https://img.shields.io/npm/dw/lucide-static) | [Docs](https://lucide.dev/guide/static) · [Source](./packages/lucide-static) | ### Figma diff --git a/docs/.vitepress/data/packageData.json b/docs/.vitepress/data/packageData.json index 4953abb9e..9dd193f59 100644 --- a/docs/.vitepress/data/packageData.json +++ b/docs/.vitepress/data/packageData.json @@ -50,20 +50,21 @@ } ] }, - "lucide-svelte": { + "@lucide/svelte": { "order": 3, "icon": "svelte", "docsAlias": "svelte", + "packageDirname": "svelte", "shields": [ { "alt": "npm", - "src": "https://img.shields.io/npm/v/lucide-svelte", - "href": "https://www.npmjs.com/package/lucide-svelte" + "src": "https://img.shields.io/npm/v/@lucide/svelte", + "href": "https://www.npmjs.com/package/@lucide/svelte" }, { "alt": "npm", - "src": "https://img.shields.io/npm/dw/lucide-svelte", - "href": "https://www.npmjs.com/package/lucide-svelte" + "src": "https://img.shields.io/npm/dw/@lucide/svelte", + "href": "https://www.npmjs.com/package/@lucide/svelte" } ] }, @@ -119,24 +120,6 @@ } ] }, - "lucide-angular": { - "order": 7, - "icon": "angular-old", - "description": "Our legacy Angular package with a module based API.", - "documentation": "https://v0.lucide.dev/guide/packages/lucide-angular", - "shields": [ - { - "alt": "npm", - "src": "https://img.shields.io/npm/v/lucide-angular", - "href": "https://www.npmjs.com/package/lucide-angular" - }, - { - "alt": "npm", - "src": "https://img.shields.io/npm/dw/lucide-angular", - "href": "https://www.npmjs.com/package/lucide-angular" - } - ] - }, "lucide-preact": { "order": 8, "icon": "preact", @@ -209,4 +192,4 @@ } ] } -} +} \ No newline at end of file diff --git a/packages/angular/README.md b/packages/angular/README.md index 8b52c2375..2f6a90dc4 100644 --- a/packages/angular/README.md +++ b/packages/angular/README.md @@ -12,7 +12,7 @@ Lucide icon library for Angular applications. [![npm](https://img.shields.io/npm/v/@lucide/angular?color=blue)](https://www.npmjs.com/package/@lucide/angular) ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/angular) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/astro/README.md b/packages/astro/README.md index 53bd63976..08e17034d 100644 --- a/packages/astro/README.md +++ b/packages/astro/README.md @@ -12,7 +12,7 @@ Lucide icon library for Astro sites and applications. [![npm](https://img.shields.io/npm/v/@lucide/astro?color=blue)](https://www.npmjs.com/package/@lucide/astro) ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/astro) -[![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) +[![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license) diff --git a/packages/icons/README.md b/packages/icons/README.md index 226f7b051..61c30eb22 100644 --- a/packages/icons/README.md +++ b/packages/icons/README.md @@ -11,7 +11,7 @@ Lucide helper library that exports icon data.

[![npm](https://img.shields.io/npm/v/@lucide/icons?color=blue)](https://www.npmjs.com/package/@lucide/icons) ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/icons) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide-angular/README.md b/packages/lucide-angular/README.md index 7f3a25fb9..b98d8df07 100644 --- a/packages/lucide-angular/README.md +++ b/packages/lucide-angular/README.md @@ -12,7 +12,7 @@ Lucide icon library for Angular applications. [![npm](https://img.shields.io/npm/v/lucide-angular?color=blue)](https://www.npmjs.com/package/lucide-angular) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-angular) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide-preact/README.md b/packages/lucide-preact/README.md index d426b2429..f0fc6beff 100644 --- a/packages/lucide-preact/README.md +++ b/packages/lucide-preact/README.md @@ -12,7 +12,7 @@ Lucide icon library for Preact applications. [![npm](https://img.shields.io/npm/v/lucide-preact?color=blue)](https://www.npmjs.com/package/lucide-preact) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-preact) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide-react-native/README.md b/packages/lucide-react-native/README.md index 5bb74509b..b19c76fe0 100644 --- a/packages/lucide-react-native/README.md +++ b/packages/lucide-react-native/README.md @@ -12,7 +12,7 @@ Lucide icon library for React Native applications. [![npm](https://img.shields.io/npm/v/lucide-react-native?color=blue)](https://www.npmjs.com/package/lucide-react-native) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react-native) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide-react/README.md b/packages/lucide-react/README.md index 7e92ba6cf..fea98b41e 100644 --- a/packages/lucide-react/README.md +++ b/packages/lucide-react/README.md @@ -12,7 +12,7 @@ Lucide icon library for React applications. [![npm](https://img.shields.io/npm/v/lucide-react?color=blue)](https://www.npmjs.com/package/lucide-react) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide-solid/README.md b/packages/lucide-solid/README.md index 308e7d640..91fab1322 100644 --- a/packages/lucide-solid/README.md +++ b/packages/lucide-solid/README.md @@ -12,7 +12,7 @@ Lucide icon library for Solid applications. [![npm](https://img.shields.io/npm/v/lucide-solid?color=blue)](https://www.npmjs.com/package/lucide-solid) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-solid) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide-static/README.md b/packages/lucide-static/README.md index 18dfc41c3..aa6b50da3 100644 --- a/packages/lucide-static/README.md +++ b/packages/lucide-static/README.md @@ -12,7 +12,7 @@ Lucide icon library with static assets for web applications. [![npm](https://img.shields.io/npm/v/lucide-static?color=blue)](https://www.npmjs.com/package/lucide-static) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-static) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide-svelte/README.md b/packages/lucide-svelte/README.md index b5b5e0f2f..1595a0e1d 100644 --- a/packages/lucide-svelte/README.md +++ b/packages/lucide-svelte/README.md @@ -12,7 +12,7 @@ Lucide icon library for Svelte applications. [![npm](https://img.shields.io/npm/v/lucide-svelte?color=blue)](https://www.npmjs.com/package/lucide-svelte) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-svelte) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

@@ -46,6 +46,7 @@ yarn add lucide-svelte ```sh bun add lucide-svelte ``` + > For Svelte 5, check out [`@lucide/svelte`](https://www.npmjs.com/package/@lucide/svelte) package. ## Documentation diff --git a/packages/lucide-vue-next/README.md b/packages/lucide-vue-next/README.md index a34b41366..b00c5a24e 100644 --- a/packages/lucide-vue-next/README.md +++ b/packages/lucide-vue-next/README.md @@ -12,7 +12,7 @@ Lucide icon library for Vue applications. [![npm](https://img.shields.io/npm/v/lucide-vue-next?color=blue)](https://www.npmjs.com/package/lucide-vue-next) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-vue-next) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/lucide/README.md b/packages/lucide/README.md index f95aafeb2..d24b03183 100644 --- a/packages/lucide/README.md +++ b/packages/lucide/README.md @@ -12,7 +12,7 @@ Lucide icon library for web applications. [![npm](https://img.shields.io/npm/v/lucide?color=blue)](https://www.npmjs.com/package/lucide) ![NPM Downloads](https://img.shields.io/npm/dw/lucide) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

diff --git a/packages/svelte/README.md b/packages/svelte/README.md index adf91243c..19165cdd5 100644 --- a/packages/svelte/README.md +++ b/packages/svelte/README.md @@ -10,9 +10,9 @@ Lucide icon library for Svelte 5 applications.

- [![npm](https://img.shields.io/npm/v/%40lucide%2Fsvelte?color=blue)](https://www.npmjs.com/package/lucide-svelte) + [![npm](https://img.shields.io/npm/v/%40lucide%2Fsvelte?color=blue)](https://www.npmjs.com/package/@lucide/svelte) ![NPM Downloads](https://img.shields.io/npm/dw/%40lucide%2Fsvelte) - [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license)

@@ -46,6 +46,7 @@ yarn add @lucide/svelte ```sh bun add @lucide/svelte ``` + > `@lucide/svelte` is only for Svelte 5, for Svelte 4 use the [`lucide-svelte`](https://www.npmjs.com/package/lucide-svelte) package. ## Documentation diff --git a/packages/vue/README.md b/packages/vue/README.md index e382abb73..e4f0c8991 100644 --- a/packages/vue/README.md +++ b/packages/vue/README.md @@ -8,6 +8,13 @@ Lucide icon library for Vue applications.

+
+ + [![npm](https://img.shields.io/npm/v/@lucide/vue?color=blue)](https://www.npmjs.com/package/@lucide/vue) + ![NPM Downloads](https://img.shields.io/npm/dw/@lucide/vue) + [![License](https://img.shields.io/badge/license-ISC-green)](https://lucide.dev/license) +
+

About · @@ -20,7 +27,7 @@ Lucide icon library for Vue applications. # Lucide Vue -Implementation of the lucide icon library for Vue 3 applications. +Implementation of the lucide icon library for Vue applications. ## Installation