From b1bf834c505111542a220022f6ea982334a2f9da Mon Sep 17 00:00:00 2001 From: Eric Fennis Date: Fri, 22 Nov 2024 14:41:56 +0100 Subject: [PATCH] Update readme files --- README.md | 11 +++ docs/guide/packages/lucide-vue.md | 4 +- 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 | 40 +++++++--- packages/lucide-preact/README.md | 36 ++++++--- packages/lucide-react-native/README.md | 39 +++++---- packages/lucide-react/README.md | 32 ++++++-- packages/lucide-solid/README.md | 35 +++++--- packages/lucide-static/README.md | 37 ++++++--- packages/lucide-svelte/README.md | 35 +++++--- packages/lucide-vue-next/README.md | 36 ++++++--- packages/lucide-vue/README.md | 40 +++++++--- packages/lucide/README.md | 34 ++++++-- 21 files changed, 462 insertions(+), 280 deletions(-) diff --git a/README.md b/README.md index cd015b26025..72dbaef90fc 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,17 @@ build status discord chat

+

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

# Lucide diff --git a/docs/guide/packages/lucide-vue.md b/docs/guide/packages/lucide-vue.md index 60799472ac5..2d8ea2e5427 100644 --- a/docs/guide/packages/lucide-vue.md +++ b/docs/guide/packages/lucide-vue.md @@ -2,8 +2,8 @@ Implementation of the lucide icon library for Vue applications. -::: error -This package is deprecated. Vue v2 is EOF See [Announcement](https://v2.vuejs.org/eol/). Migrate to Vue 3. +::: 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 3ffd2d6cbfc..fc6146d7c76 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 98a2227a6b9..4b8edaed14a 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 5400d4ad0f8..59ac28595ee 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 2e638d272c8..9c1fcdd8ee0 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 21304bd454c..4e90cc89d78 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 9dfa9699260..b19bf1d6c0d 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 4ab04e88d5e..6f2fc235291 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 6a21dbb8ad0..76603434a88 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 8c2a462e021..52e52c82080 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 3779e38bb91..f22f0268fea 100644 --- a/packages/lucide-angular/README.md +++ b/packages/lucide-angular/README.md @@ -1,30 +1,44 @@

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

+Lucide icon library for Angular applications. +

+ +
-Implementation of the 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) +
-> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +

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

## 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 05d37d5d288..2763cf5b0b9 100644 --- a/packages/lucide-preact/README.md +++ b/packages/lucide-preact/README.md @@ -1,30 +1,44 @@

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

+Lucide icon library for Preact applications. +

+ +
-Implementation of the 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) +
-> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +

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

## 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 f82945d4b28..62c84cf2f86 100644 --- a/packages/lucide-react-native/README.md +++ b/packages/lucide-react-native/README.md @@ -1,36 +1,47 @@

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

-# Lucide React Native +
-Implementation of the 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) +
-> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +

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

## 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) +For full documentation, visit [lucide.dev](https://lucide.dev/guide/packages/lucide-react-native-native) ## Community diff --git a/packages/lucide-react/README.md b/packages/lucide-react/README.md index 00cd6c146f7..11d17d3ad52 100644 --- a/packages/lucide-react/README.md +++ b/packages/lucide-react/README.md @@ -1,28 +1,44 @@

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

+

+Lucide icon library for React applications. +

-# Lucide React +
-Implementation of the 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) +
-> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +

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

## 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 88abae1be85..2365f18a0f4 100644 --- a/packages/lucide-solid/README.md +++ b/packages/lucide-solid/README.md @@ -1,31 +1,44 @@

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

-# Lucide Solid +
-Implementation of the 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) +
-> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +

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

## 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 e613619aa14..2d7c36ca45a 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 5d8fb60aa3e..9a11be0ac0d 100644 --- a/packages/lucide-svelte/README.md +++ b/packages/lucide-svelte/README.md @@ -1,31 +1,44 @@

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

-# Lucide Svelte +
-Implementation of the 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) +
-> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +

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

## 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 933197ada66..969f0cc0199 100644 --- a/packages/lucide-vue-next/README.md +++ b/packages/lucide-vue-next/README.md @@ -1,32 +1,44 @@

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

-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). + [![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) +
-> :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) +

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

## 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 a795cd87eb5..77e30eba404 100644 --- a/packages/lucide-vue/README.md +++ b/packages/lucide-vue/README.md @@ -1,32 +1,48 @@

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

+Lucide icon library for Vue 2 applications. +

+ +
-Implementation of the 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) + [![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license) +
-> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide). +

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

-> :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 a50739998fe..05051d850f1 100644 --- a/packages/lucide/README.md +++ b/packages/lucide/README.md @@ -1,26 +1,44 @@

- - 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 +## Installation ```sh -npm install lucide +pnpm add lucide ``` ```sh -pnpm install lucide +npm install lucide ``` ```sh