Skip to content

Commit

Permalink
docs: add features
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnaceMaes committed Apr 28, 2024
1 parent 3ba4b85 commit b57c341
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down

0 comments on commit b57c341

Please sign in to comment.