Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
gronxb committed Sep 14, 2024
1 parent 7a50318 commit fe9c855
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ Check out the icons you want here and enter the following command:

## Motivation

React Icons are not natively compatible with React Native. Bundling all icons from React Icons into a React Native project can lead to larger bundle sizes since Metro doesn’t support Tree Shaking effectively. This tool provides an easy way to use React Icons within React Native without the risk of bloated bundle sizes.
* **React Icons are not natively compatible with React Native:** React Icons is a popular library for web applications but doesn’t work out of the box with React Native. This tool provides a way to transform React Icons into React Native components, making them usable without unnecessary overhead.

* **Metro doesn’t support Tree Shaking effectively:** Metro, the bundler used in React Native, lacks efficient Tree Shaking capabilities. Therefore, bundling all of the React Icons together could lead to increased bundle sizes. This tool minimizes bundle size by allowing you to install only the icons you need directly into your project.

## Key Features

* No additional dependencies are required, except for `react-native-svg`, which is commonly used in React Native.
* No native code is involved, making it simple to integrate.
* Supports all icons available in the React Icons library.
* Designed with zero external dependencies (except for `react-native-svg`).
* No native code is involved, making it simple to integrate.

## Usage
* Basic
Expand Down

0 comments on commit fe9c855

Please sign in to comment.