@ng-icons/heroicons 12.5.0 → 13.1.0

package/README.md

@@ -1,31 +1,35 @@
 # Ng Icons
 
 The all-in-one icon library for Angular. This allows you to use icons from multiple icon sets with a single icon component.
+Containing over 17000+ icons for you to use in your projects.
 
 Currently, we support the following libraries:
 
+- [Bootstrap Icons](https://icons.getbootstrap.com/)
 - [Heroicons](https://heroicons.com/)
+- [Ionicons](https://ionic.io/ionicons)
+- [Material Icons](https://fonts.google.com/icons?selected=Material+Icons)
 - [CSS.gg](https://css.gg/)
 - [Feather Icons](https://feathericons.com/)
 - [Jam Icons](https://jam-icons.com/)
 - [Octicons](https://github.com/primer/octicons)
 - [Radix UI Icons](https://icons.modulz.app/)
 - [Tabler Icons](https://tabler-icons.io/)
+- [Akar Icons](https://akaricons.com/)
 
 Got suggestions for additional iconsets? Create an issue and we can consider adding them!
 
-## Installation
+## Supported Versions
+
+| Angular Version | Ng Icon Version    |
+| --------------- | ------------------ |
+| 11.x.x          | 12.x.x             |
+| 12.x.x          | 13.x.x (or 12.x.x) |
+| 13.x.x          | 13.x.x             |
 
-Ng Icons consists of multiple packages:
+> Note: Ng Icons relies on modern browser features and is designed to work on evergreen browsers. We do not support older browsers such as IE11.
 
-- `@ng-icons/core` - This contains the icon component and the `NgIconsModule` that is used to register the icons you want to include in your application.
-- `@ng-icons/heroicons` - The Heroicons iconset including both outline and solid variants.
-- `@ng-icons/css.gg` - The CSS.gg iconset.
-- `@ng-icons/feather-icons` - The Feather Icons iconset.
-- `@ng-icons/jam-icons` - The Jam Icons iconset.
-- `@ng-icons/octicons` - The Octicons iconset.
-- `@ng-icons/radix-icons` - The Radix UI iconset.
-- `@ng-icons/tabler-icons` - The Tabler iconset.
+## Installation
 
 You must install the `@ng-icons/core` package, however you only need to install the iconset libraries you intend to use.
 
@@ -41,6 +45,25 @@ or
 yarn add @ng-icons/core @ng-icons/heroicons ...
 ```
 
+## Packages
+
+The following packages are available:
+
+| Package                     | License    |
+| --------------------------- | ---------- |
+| `@ng-icons/core`            | MIT        |
+| `@ng-icons/bootstrap-icons` | MIT        |
+| `@ng-icons/heroicons`       | MIT        |
+| `@ng-icons/ionicons`        | MIT        |
+| `@ng-icons/material-icons`  | Apache 2.0 |
+| `@ng-icons/css.gg`          | MIT        |
+| `@ng-icons/feather-icons`   | MIT        |
+| `@ng-icons/jam-icons`       | MIT        |
+| `@ng-icons/octicons`        | MIT        |
+| `@ng-icons/radix-icons`     | MIT        |
+| `@ng-icons/tabler-icons`    | MIT        |
+| `@ng-icons/akar-icons`      | MIT        |
+
 ## Usage
 
 Import the `NgIconsModule` and register the icons you wish to use:
@@ -67,7 +90,8 @@ You can then use the icon in your templates:
 <ng-icon name="feather-airplay"></ng-icon>
 ```
 
-| Name        | Type             | Description                          |
-| ----------- | ---------------- | ------------------------------------ |
-| size        | string           | Define the size of the icon.         |
-| strokeWidth | string \| number | Define the stroke-width of the icon. |
+| Name        | Type                 | Description                                                                        |
+| ----------- | -------------------- | ---------------------------------------------------------------------------------- |
+| size        | `string`             | Define the size of the icon. This defaults to the current font size.               |
+| color       | `string`             | Define the color of the icon. This defaults to the current text color.             |
+| strokeWidth | `string` \| `number` | Define the stroke-width of the icon. This only works on iconsets that use strokes. |