From c6c645ca7fc9655a2617de9b0229556468a121b0 Mon Sep 17 00:00:00 2001 From: Eric Fennis Date: Mon, 25 Nov 2024 12:01:13 +0100 Subject: [PATCH] docs(readme): Update readme files (#2634) * Update readme files * Update readme files * Fix typos react native readme * Add back headings --- README.md | 258 ++---------------- docs/.vitepress/data/packageData.json | 56 ++-- docs/.vitepress/sidebar.ts | 12 +- docs/guide/packages/lucide-vue-next.md | 6 - docs/guide/packages/lucide-vue.md | 11 +- docs/public/package-logos/lucide-angular.svg | 55 ++-- docs/public/package-logos/lucide-preact.svg | 31 ++- .../package-logos/lucide-react-native.svg | 53 ++-- docs/public/package-logos/lucide-react.svg | 31 ++- docs/public/package-logos/lucide-solid.svg | 79 +++--- docs/public/package-logos/lucide-static.svg | 33 ++- docs/public/package-logos/lucide-svelte.svg | 27 +- docs/public/package-logos/lucide-vue.svg | 27 +- docs/public/package-logos/lucide.svg | 27 +- packages/lucide-angular/README.md | 42 ++- packages/lucide-preact/README.md | 40 ++- packages/lucide-react-native/README.md | 39 ++- packages/lucide-react/README.md | 39 ++- packages/lucide-solid/README.md | 37 ++- packages/lucide-static/README.md | 37 ++- packages/lucide-svelte/README.md | 37 ++- packages/lucide-vue-next/README.md | 42 ++- packages/lucide-vue/README.md | 42 ++- packages/lucide/README.md | 34 ++- 24 files changed, 528 insertions(+), 567 deletions(-) diff --git a/README.md b/README.md index 6076562c3..72dbaef90 100644 --- a/README.md +++ b/README.md @@ -8,185 +8,39 @@

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

+

+ Icons + · + Guide + · + Packages + · + License + · + Showcase +

# Lucide -Community-run fork of [Feather Icons](https://github.com/feathericons/feather), open for anyone to contribute icons. +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. -It began after growing dissatisfaction with the [Feather Icons](https://github.com/feathericons/feather) project moderation. With over 300+ open issues and over 100+ open PRs, the Feather Icons project has been abandoned. This unfortunately means that hundreds of developers and designers wasted their time contributing to Feather Icons with no chance of PRs being accepted. +## Packages -Lucide is trying to expand the icon set as much as possible while staying faithful to the original simplistic design language. We do this as a community of devs and designers and hope that you'll join us! - -### Why choose Lucide over Feather Icons - -- More icons to work with: Lucide already has hundreds of icons more than Feather does. -- Official libraries and integrations with popular frameworks and design tools. -- Well maintained code base. -- Active community, regularly growing and improving the set. - -## Table of Contents - -- [Usage](#usage) - - [Web](#web) - - [React](#react) - - [React Native](#react-native) - - [Vue 2](#vue-2) - - [Vue 3](#vue-3) - - [Angular](#angular) - - [Preact](#preact) - - [Static (svg sprite, font, icons ..)](#static-svg-sprite-font-icons-) - - [Figma](#figma) - - [Laravel](#laravel) - - [Svelte](#svelte) - - [Solid](#solid) - - [Hyva](#hyva) - - [Eleventy](#eleventy) -- [Contributing](#contributing) -- [Community](#community) -- [License](#license) -- [Credits](#credits) -- [Sponsors](#sponsors) - -## Usage - -At its core, Lucide is a collection of [SVG](https://svgontheweb.com/#svg) files. This means that you can use Lucide icons in all the same ways you can use SVGs (e.g. `img`, `background-image`, `inline`, `object`, `embed`, `iframe`). Here's a helpful article detailing the many ways SVGs can be used on the web: [SVG on the Web – Implementation Options](https://svgontheweb.com/#implementation) - -The following are additional ways you can use Lucide. -With the Javascript library you can easily incorporate the icon you want in your webpage. - -### Web - -Implementation of the lucide icon library for web applications. - -```sh -npm install lucide -``` - -or - -```sh -yarn add lucide -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide#lucide). - -### React - -Implementation of the lucide icon library for react applications. - -```sh -yarn add lucide-react -``` - -or - -```sh -npm install lucide-react -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-react#lucide-react). - -### React Native - -Implementation of the lucide icon library for React Native applications. - -```sh -yarn add lucide-react-native -``` - -or - -```sh -npm install lucide-react-native -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-react-native#lucide-react-native). - -### Vue 2 - -Implementation of the lucide icon library for vue applications. - -```sh -yarn add lucide-vue -``` - -or - -```sh -npm install lucide-vue -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue#lucide-vue). - -### Vue 3 - -Implementation of the lucide icon library for vue applications. - -```sh -yarn add lucide-vue-next -``` - -or - -```sh -npm install lucide-vue-next -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue-next#lucide-vue-next). - -### Angular - -```sh -yarn add lucide-angular -``` - -or - -```sh -npm install lucide-angular -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-angular#lucide-angular). - -### Preact - -Implementation of the lucide icon library for preact applications. - -```sh -yarn add lucide-preact -``` - -or - -```sh -npm install lucide-preact -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-preact#lucide-preact). - -### Static (svg sprite, font, icons ..) - -Assets: -[Font Files](https://github.com/lucide-icons/lucide/releases/latest) -[SVG Files](https://github.com/lucide-icons/lucide/releases/latest) -[SVG Sprite](https://cdn.jsdelivr.net/npm/lucide-static@latest/sprite.svg) - -NPM package - -```sh -yarn add lucide-static -``` - -or - -```sh -npm install lucide-static -``` +| | 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) | +| 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) | ### Figma @@ -196,68 +50,6 @@ Visit [Figma community page](https://www.figma.com/community/plugin/939567362549 Figma Lucide Cover -### Laravel - -Implementation of Lucide icon's using `blade-icons` for Laravel based projects. - -```sh -composer require mallardduck/blade-lucide-icons -``` - -For more details, see the [documentation](https://github.com/mallardduck/blade-lucide-icons/blob/main/README.md). - -### Svelte - -Implementation of the lucide icon library for Svelte applications. - -```sh -yarn add lucide-svelte -``` - -or - -```sh -npm install lucide-svelte -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-svelte#lucide-svelte). - -### Solid - -Implementation of the lucide icon library for solid applications. - -```sh -yarn add lucide-solid -``` - -or - -```sh -npm install lucide-solid -``` - -For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-solid#lucide-solid). - -### Hyva - -Implementation of Lucide icon's using Hyvä's svg php viewmodal to render icons for Magento 2 Hyva theme based projects. - -```sh -composer require siteation/magento2-hyva-icons-lucide -``` - -For more details, see the [documentation](https://github.com/Siteation/magento2-hyva-icons-lucide/blob/main/README.md). - -### Eleventy - -Using this plugin, Eleventy projects can incorporate Lucide icons. it makes it simple to use Lucide icons into your themes via shortcodes, improving your website's overall usability and visual appeal. - -```sh -npm install @grimlink/eleventy-plugin-lucide-icons -``` - -For more details, see the [documentation](https://github.com/GrimLink/eleventy-plugin-lucide-icons/blob/main/README.md). - ## Contributing For more info on how to contribute please see the [contribution guidelines](https://github.com/lucide-icons/lucide/blob/main/CONTRIBUTING.md). diff --git a/docs/.vitepress/data/packageData.json b/docs/.vitepress/data/packageData.json index 613ed60e7..c4a62adf1 100644 --- a/docs/.vitepress/data/packageData.json +++ b/docs/.vitepress/data/packageData.json @@ -31,24 +31,8 @@ } ] }, - "lucide-vue": { - "order": 2, - "icon": "vue", - "shields": [ - { - "alt": "npm", - "src": "https://img.shields.io/npm/v/lucide-vue", - "href": "https://www.npmjs.com/package/lucide-vue" - }, - { - "alt": "npm", - "src": "https://img.shields.io/npm/dw/lucide-vue", - "href": "https://www.npmjs.com/package/lucide-vue" - } - ] - }, "lucide-vue-next": { - "order": 3, + "order": 2, "icon": "vue-next", "shields": [ { @@ -64,7 +48,7 @@ ] }, "lucide-svelte": { - "order": 4, + "order": 3, "icon": "svelte", "shields": [ { @@ -95,24 +79,8 @@ } ] }, - "lucide-preact": { - "order": 5, - "icon": "preact", - "shields": [ - { - "alt": "npm", - "src": "https://img.shields.io/npm/v/lucide-preact", - "href": "https://www.npmjs.com/package/lucide-preact" - }, - { - "alt": "npm", - "src": "https://img.shields.io/npm/dw/lucide-preact", - "href": "https://www.npmjs.com/package/lucide-preact" - } - ] - }, "lucide-react-native": { - "order": 6, + "order": 5, "icon": "react-native", "shields": [ { @@ -128,7 +96,7 @@ ] }, "lucide-angular": { - "order": 7, + "order": 6, "icon": "angular", "shields": [ { @@ -143,6 +111,22 @@ } ] }, + "lucide-preact": { + "order": 7, + "icon": "preact", + "shields": [ + { + "alt": "npm", + "src": "https://img.shields.io/npm/v/lucide-preact", + "href": "https://www.npmjs.com/package/lucide-preact" + }, + { + "alt": "npm", + "src": "https://img.shields.io/npm/dw/lucide-preact", + "href": "https://www.npmjs.com/package/lucide-preact" + } + ] + }, "lucide-static": { "order": 8, "icon": "svg", diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts index 5833648f0..ad796b962 100644 --- a/docs/.vitepress/sidebar.ts +++ b/docs/.vitepress/sidebar.ts @@ -72,10 +72,6 @@ const sidebar: UserConfig['themeConfig']['sidebar'] = { text: 'Lucide React', link: '/guide/packages/lucide-react', }, - { - text: 'Lucide React Native', - link: '/guide/packages/lucide-react-native', - }, { text: 'Lucide Vue', link: '/guide/packages/lucide-vue-next', @@ -89,13 +85,17 @@ const sidebar: UserConfig['themeConfig']['sidebar'] = { link: '/guide/packages/lucide-solid', }, { - text: 'Lucide Preact', - link: '/guide/packages/lucide-preact', + text: 'Lucide React Native', + link: '/guide/packages/lucide-react-native', }, { text: 'Lucide Angular', link: '/guide/packages/lucide-angular', }, + { + text: 'Lucide Preact', + link: '/guide/packages/lucide-preact', + }, { text: 'Lucide Static', link: '/guide/packages/lucide-static', diff --git a/docs/guide/packages/lucide-vue-next.md b/docs/guide/packages/lucide-vue-next.md index 4d406d0cb..99daae2f5 100644 --- a/docs/guide/packages/lucide-vue-next.md +++ b/docs/guide/packages/lucide-vue-next.md @@ -2,12 +2,6 @@ Implementation of the lucide icon library for Vue 3 applications. -## Vue 3 or Vue 2 - -::: tip -This version of lucide is for Vue 3, For Vue 2 got to [lucide-vue ->](lucide-vue) -::: - ## Installation ::: code-group diff --git a/docs/guide/packages/lucide-vue.md b/docs/guide/packages/lucide-vue.md index efdc8f42a..2d8ea2e54 100644 --- a/docs/guide/packages/lucide-vue.md +++ b/docs/guide/packages/lucide-vue.md @@ -2,15 +2,8 @@ Implementation of the lucide icon library for Vue applications. -::: warning -This package will be deprecated end of 2023. Vue v2 will be EOF at the end of 2023 See [Announcement](https://v2.vuejs.org/lts/). We recommend to migrate to Vue 3. -The Lucide Vue package will be only maintained for Vue 3 after the deprecation. -::: - -## Vue 2 or Vue 3 - -::: tip -This version of lucide is for Vue 2, For Vue 3 go to [lucide-vue-next ->](lucide-vue-next) +::: danger +This package is deprecated. Vue 2 is EOF See [Announcement](https://v2.vuejs.org/eol/). Migrate to Vue 3. ::: ## Installation diff --git a/docs/public/package-logos/lucide-angular.svg b/docs/public/package-logos/lucide-angular.svg index 3ffd2d6cb..fc6146d7c 100644 --- a/docs/public/package-logos/lucide-angular.svg +++ b/docs/public/package-logos/lucide-angular.svg @@ -1,27 +1,30 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide-preact.svg b/docs/public/package-logos/lucide-preact.svg index 98a2227a6..4b8edaed1 100644 --- a/docs/public/package-logos/lucide-preact.svg +++ b/docs/public/package-logos/lucide-preact.svg @@ -1,15 +1,18 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide-react-native.svg b/docs/public/package-logos/lucide-react-native.svg index 5400d4ad0..59ac28595 100644 --- a/docs/public/package-logos/lucide-react-native.svg +++ b/docs/public/package-logos/lucide-react-native.svg @@ -1,26 +1,29 @@ - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide-react.svg b/docs/public/package-logos/lucide-react.svg index 2e638d272..9c1fcdd8e 100644 --- a/docs/public/package-logos/lucide-react.svg +++ b/docs/public/package-logos/lucide-react.svg @@ -1,15 +1,18 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide-solid.svg b/docs/public/package-logos/lucide-solid.svg index 21304bd45..4e90cc89d 100644 --- a/docs/public/package-logos/lucide-solid.svg +++ b/docs/public/package-logos/lucide-solid.svg @@ -1,39 +1,42 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide-static.svg b/docs/public/package-logos/lucide-static.svg index 9dfa96992..b19bf1d6c 100644 --- a/docs/public/package-logos/lucide-static.svg +++ b/docs/public/package-logos/lucide-static.svg @@ -1,16 +1,19 @@ - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide-svelte.svg b/docs/public/package-logos/lucide-svelte.svg index 4ab04e88d..6f2fc2352 100644 --- a/docs/public/package-logos/lucide-svelte.svg +++ b/docs/public/package-logos/lucide-svelte.svg @@ -1,13 +1,16 @@ - - - - - - - - - - - - + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide-vue.svg b/docs/public/package-logos/lucide-vue.svg index 6a21dbb8a..76603434a 100644 --- a/docs/public/package-logos/lucide-vue.svg +++ b/docs/public/package-logos/lucide-vue.svg @@ -1,13 +1,16 @@ - - - - - - - - - - - - + + + + + + + + + + + + + + + diff --git a/docs/public/package-logos/lucide.svg b/docs/public/package-logos/lucide.svg index 8c2a462e0..52e52c820 100644 --- a/docs/public/package-logos/lucide.svg +++ b/docs/public/package-logos/lucide.svg @@ -1,13 +1,16 @@ - - - - - - - - - - - - + + + + + + + + + + + + + + + diff --git a/packages/lucide-angular/README.md b/packages/lucide-angular/README.md index 3779e38bb..af46937d1 100644 --- a/packages/lucide-angular/README.md +++ b/packages/lucide-angular/README.md @@ -1,30 +1,48 @@

- - Lucide Angular - Implementation of the lucide icon library for angular applications. - - - Lucide Angular - Implementation of the lucide icon library for angular applications. + + Lucide icon library for Angular applications.

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

+ # Lucide Angular Implementation of the lucide icon library for angular applications. -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). - ## Installation -```bash -yarn add lucide-angular +```sh +pnpm add lucide-angular ``` -or - -```bash +```sh npm install lucide-angular ``` +```sh +yarn add lucide-angular +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-angular) diff --git a/packages/lucide-preact/README.md b/packages/lucide-preact/README.md index 05d37d5d2..dbcf6aa02 100644 --- a/packages/lucide-preact/README.md +++ b/packages/lucide-preact/README.md @@ -1,30 +1,48 @@

- - Lucide Preact - Implementation of the lucide icon library for preact applications. - - - Lucide Preact - Implementation of the lucide icon library for preact applications. + + Lucide icon library for Preact applications.

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

+ # Lucide Preact -Implementation of the lucide icon library for preact applications. - -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +Implementation of the lucide icon library for Preact applications. ## Installation ```sh -yarn add lucide-preact +pnpm add lucide-preact ``` -or - ```sh npm install lucide-preact ``` +```sh +yarn add lucide-preact +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-preact) diff --git a/packages/lucide-react-native/README.md b/packages/lucide-react-native/README.md index f82945d4b..7e16884fe 100644 --- a/packages/lucide-react-native/README.md +++ b/packages/lucide-react-native/README.md @@ -1,33 +1,48 @@

- - Lucide React Native - Implementation of the lucide icon library for React Native applications. - - - Lucide React Native - Implementation of the lucide icon library for React Native applications. + + Lucide icon library for React Native applications.

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

# Lucide React Native Implementation of the lucide icon library for React Native applications. -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). - ## Installation -First, ensure that you have `react-native-svg` (version between 12 and 15) installed. Then, install the package: - ```sh -yarn add lucide-react-native +pnpm add lucide-react-native ``` -or - ```sh npm install lucide-react-native ``` +```sh +yarn add lucide-react-native +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-react-native) diff --git a/packages/lucide-react/README.md b/packages/lucide-react/README.md index ed816ec26..672e838f6 100644 --- a/packages/lucide-react/README.md +++ b/packages/lucide-react/README.md @@ -1,31 +1,48 @@

- - Lucide React - Implementation of the lucide icon library for react applications. - - - Lucide React - Implementation of the lucide icon library for react applications. + + Lucide icon library for React applications.

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

# Lucide React -Implementation of the lucide icon library for react applications. - -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +Implementation of the lucide icon library for React applications. ## Installation ```sh -yarn add lucide-react +pnpm add lucide-react ``` -or - ```sh npm install lucide-react ``` +```sh +yarn add lucide-react +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-react) diff --git a/packages/lucide-solid/README.md b/packages/lucide-solid/README.md index 88abae1be..653c9b16d 100644 --- a/packages/lucide-solid/README.md +++ b/packages/lucide-solid/README.md @@ -1,31 +1,48 @@

- - Lucide Solid - Implementation of the lucide icon library for solid applications. - - - Lucide Solid - Implementation of the lucide icon library for solid applications. + + Lucide icon library for Solid applications.

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

# Lucide Solid Implementation of the lucide icon library for solid applications. -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). - ## Installation ```sh -yarn add lucide-solid +pnpm add lucide-solid ``` -or - ```sh npm install lucide-solid ``` +```sh +yarn add lucide-solid +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-solid) diff --git a/packages/lucide-static/README.md b/packages/lucide-static/README.md index e613619aa..2d7c36ca4 100644 --- a/packages/lucide-static/README.md +++ b/packages/lucide-static/README.md @@ -1,12 +1,29 @@

- - Lucide Static - Implementation of the lucide icon library for web applications. - - - Lucide Static - Implementation of the lucide icon library for web applications. + + Lucide icon library with static assets for web applications

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

# Lucide Static @@ -28,18 +45,18 @@ This package is suitable for very specific use cases for example if you want to ## Installation -## Package Managers - ```sh -yarn add lucide-static +pnpm add lucide-static ``` -or - ```sh npm install lucide-static ``` +```sh +yarn add lucide-static +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-static) diff --git a/packages/lucide-svelte/README.md b/packages/lucide-svelte/README.md index 5d8fb60aa..0b629bf26 100644 --- a/packages/lucide-svelte/README.md +++ b/packages/lucide-svelte/README.md @@ -1,31 +1,48 @@

- - Lucide Svelte - Implementation of the lucide icon library for svelte applications. - - - Lucide Svelte - Implementation of the lucide icon library for web applications. + + Lucide icon library for Svelte applications.

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

# Lucide Svelte Implementation of the lucide icon library for svelte applications. -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). - ## Installation ```sh -yarn add lucide-svelte +pnpm add lucide-svelte ``` -or - ```sh npm install lucide-svelte ``` +```sh +yarn add lucide-svelte +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-svelte) diff --git a/packages/lucide-vue-next/README.md b/packages/lucide-vue-next/README.md index 933197ada..d7223c046 100644 --- a/packages/lucide-vue-next/README.md +++ b/packages/lucide-vue-next/README.md @@ -1,32 +1,48 @@

- - Lucide Vue Next - Implementation of the lucide icon library for Vue 3 applications. - - - Lucide Vue Next - Implementation of the lucide icon library for Vue 3 applications. + + Lucide icon library for Vue applications.

-# Lucide Vue Next +

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

+ +# Lucide Vue Implementation of the lucide icon library for Vue 3 applications. -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). - -> :warning: This version of lucide is for Vue 3, For Vue 2 got to [lucide-vue](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue#lucide-vue) - ## Installation ```sh -yarn add lucide-vue-next +pnpm add lucide-vue-next ``` -or - ```sh npm install lucide-vue-next ``` +```sh +yarn add lucide-vue-next +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-vue-next) diff --git a/packages/lucide-vue/README.md b/packages/lucide-vue/README.md index a795cd87e..341d1ca52 100644 --- a/packages/lucide-vue/README.md +++ b/packages/lucide-vue/README.md @@ -1,32 +1,52 @@

- - Lucide Vue - Implementation of the lucide icon library for Vue applications. - - - Lucide Vue - Implementation of the lucide icon library for Vue applications. + + Lucide icon library for Vue 2 applications.

+

+Lucide icon library for Vue 2 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) + [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) +
+ +

+ About + · + Icons + · + Documentation + · + License +

+ # Lucide Vue Implementation of the lucide icon library for Vue applications. -> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). - -> :warning: This version of lucide is for Vue 2, For Vue 3 got to [lucide-vue-next](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue-next#lucide-vue-next) +> :rotating_light: +This package is deprecated. Vue 2 is EOF See [Announcement](https://v2.vuejs.org/eol/). Migrate to Vue 3. +::: ## Installation ```sh -yarn add lucide-vue +pnpm add lucide-vue ``` -or - ```sh npm install lucide-vue ``` +```sh +yarn add lucide-vue +``` + ## Documentation For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-vue) diff --git a/packages/lucide/README.md b/packages/lucide/README.md index a50739998..2dcc9b006 100644 --- a/packages/lucide/README.md +++ b/packages/lucide/README.md @@ -1,26 +1,42 @@

- - Lucide - Implementation of the lucide icon library for web applications. - - - Lucide - Implementation of the lucide icon library for web applications. + + Lucide icon library for web applications.

+

+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) +
+ +

+ About + · + Icons + · + Documentation + · + License +

+ # Lucide Implementation of the lucide icon library for web applications. ## Installation -### Package Managers - ```sh -npm install lucide +pnpm add lucide ``` ```sh -pnpm install lucide +npm install lucide ``` ```sh