From 67131489c8df86e78e17267bc874e0b171094772 Mon Sep 17 00:00:00 2001 From: locness3 <37651007+locness3@users.noreply.github.com> Date: Sun, 23 Apr 2023 10:31:02 +0200 Subject: [PATCH] lucide-static.md : rephrase warning and improve small details (#1123) * lucide-static.md : rephrase warning and improve small details * more capitalization of "svg" --- docs/packages/lucide-static.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/packages/lucide-static.md b/docs/packages/lucide-static.md index a753b9147..802bd2c0d 100644 --- a/docs/packages/lucide-static.md +++ b/docs/packages/lucide-static.md @@ -2,16 +2,16 @@ This package include the following lucide implementations: -- All svg files -- Javascript library containing strings of svgs. +- All SVG files +- SVG sprite - Icon fonts -- Svg sprite +- JavaScript library containing strings of SVGs. ## Why lucide-static? -This package is suitable for very specific use cases for example if you want to use icon fonts, svg sprites, normal svgs or Common.js Svg strings in your javascript project. +This package is suitable for specific use cases, for example if you want to use icon fonts, SVG sprites, normal SVGs or Common.js SVG strings in your javascript project. -> ⚠️ It is not recommended to use this package for svg sprites or icon fonts for web pages/applications, for prototyping it is ok. We recommend to bundlers for web applications to make sure you only bundle the used icons from this icon library (Treeshaking). Otherwise it will load all the icons, making you webpage loading slower. Threeshaking is only available in the packages: [lucide](lucide), [lucide-react](lucide-react), [lucide-vue](lucide-vue), [lucide-vue-next](lucide-vue-next), [lucide-angular](lucide-angular), [lucide-preact](lucide-preact) +> ⚠️ While they can be useful for prototyping, it is not recommended to use the SVG sprites or icon fonts provided by this package in production web apps as all the available icons are included in the app, hence increasing loading time and data usage. We recommend to use a bundler and treeshaking to make sure only the icons you use are bundled with your app. Threeshaking is only available in these packages: [lucide](lucide), [lucide-react](lucide-react), [lucide-vue](lucide-vue), [lucide-vue-next](lucide-vue-next), [lucide-angular](lucide-angular), [lucide-preact](lucide-preact) ## Installation @@ -30,10 +30,10 @@ npm install lucide-static ### CDN ```html - + - +