From 2502207a1e5cc95c6986d0e58a4ca34814687afa Mon Sep 17 00:00:00 2001 From: Austin Gatlin Date: Thu, 10 Mar 2022 22:49:44 +1100 Subject: [PATCH] Minor edits to react readme. (#520) * Minor edits to react readme. * Update packages/lucide-react/README.md Co-authored-by: hornta <4553604+hornta@users.noreply.github.com> Co-authored-by: hornta <4553604+hornta@users.noreply.github.com> --- packages/lucide-react/README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/packages/lucide-react/README.md b/packages/lucide-react/README.md index a05a5bcb5..cab108fb3 100644 --- a/packages/lucide-react/README.md +++ b/packages/lucide-react/README.md @@ -16,7 +16,7 @@ npm install lucide-react ## How to use -It's build with ESmodules so it's completely threeshakable. +It's built with ES modules so it's completely threeshakable. Each icon can be imported as a react component. ### Example @@ -25,9 +25,7 @@ You can pass additional props to adjust the icon. ``` js import { Camera } from 'lucide-react'; -// Returns ReactComponent -// Usage const App = () => { return }; @@ -48,19 +46,16 @@ export default App; You can also pass custom props that will be added in the svg as attributes. ``` js -// Usage const App = () => { return }; ``` -### One generic icon component +### Generic icon component -It is possible to create one generic icon component to load icons. +It is possible to create a generic icon component to load icons. -> :warning: Example below importing all EsModules, caution using this example, not recommended when you using bundlers, your application build size will grow strongly. - -#### Icon Component Example +> :warning: The example below is importing all ES modules. This is **not** recommended when you using a bundler since your application build size will grow substantially. ``` js import * as icons from 'lucide-react';