From b533cf8480ab8bf1ccefb60255ebabb1ecc37b97 Mon Sep 17 00:00:00 2001 From: Collin Monahan <41239783+llaenowyd@users.noreply.github.com> Date: Sat, 31 Oct 2020 11:11:18 -0400 Subject: [PATCH] doc/spelling (#120) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 17db9af9696..c94642bc39d 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Lucide is a community-run fork of [Feather Icons](https://github.com/feathericon * [Unpkg](#with-unpkg) * [ESModules](#with-esmodules) * [Options](#additional-options) - * [Threeshake library](#threeshake-the-library-only-use-the-icons-you-use) + * [Treeshake library](#treeshake-the-library-only-use-the-icons-you-use) * [Custom binding](#custom-element-binding) * [Figma](#figma) * [Contributing](#contributing) @@ -73,7 +73,7 @@ Here is a complete example with unpkg ### With ESModules -To reduce bundle size, lucide is build to be fully threeshakeble. +To reduce bundle size, lucide is built to be fully treeshakable. The `createIcons` function will search for HTMLElements with the attribute `icon-name` and replace it with the svg from the given icon name. ```html @@ -84,7 +84,7 @@ The `createIcons` function will search for HTMLElements with the attribute `icon ```js import { createIcons, icons } from 'lucide'; -// Caustion, this will import all the icons and bundle them. +// Caution, this will import all the icons and bundle them. createIcons({icons}); // Recommended way, to include only the icons you need. @@ -118,7 +118,7 @@ createIcons({ }); ``` -#### Threeshake the library, only use the icons you use +#### Treeshake the library, only use the icons you use ```js import { createIcons, Menu, ArrowRight, Globe } from 'lucide';