diff --git a/README.md b/README.md index 2b51a60b..360071b2 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,22 @@ Phosphor is a flexible icon family for interfaces, diagrams, presentations โ€” w [![npm](https://img.shields.io/npm/v/ember-phosphor-icons)](https://npm.im/ember-phosphor-icons) +## Features + +- ๐Ÿ”ฅ **1.5K+ icons**: A large set of icons - with 6 variants per icon. +- ๐Ÿ’™ **TypeScript and Glint support**: Glint types are provided for strict template checking. +- ๐ŸŒฒ **Tree-shakable**: Only include the icons which are actually used in your application. +- ๐ŸŽจ **Customizable**: Change the icon's color, size, and weight with simple arguments. +- ๐Ÿงต **V2 addon format**: Ready for modern Ember. + ## Compatibility - Ember.js v4.12 or above - Embroider or ember-auto-import v2 +> [!IMPORTANT] +> It is highly recommended to only use this addon with Embroider. Otherwise you do not get the benefit of tree shaking and the full icon set will be included which increases the bundle size by a lot. + ## Installation ```