Skip to content

Commit 35ac004

Browse files
committed
Add badges for npm version, downloads, and license to README files for better visibility and information.
1 parent e8ffca6 commit 35ac004

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Astro Iconset
22

3+
[![npm version](https://img.shields.io/npm/v/astro-iconset?color=blue)](https://www.npmjs.com/package/astro-iconset)
4+
[![npm downloads](https://img.shields.io/npm/dm/astro-iconset)](https://www.npmjs.com/package/astro-iconset)
5+
[![license](https://img.shields.io/npm/l/astro-iconset)](./LICENSE)
6+
37
[Astro](https://astro.build) integration for SVG icons: local files, [Iconify](https://iconify.design) collections. Icons are optimized at build time, repeated uses can share a sprite, and the package ships no extra runtime to the browser.
48

59
**Install in an Astro project**

packages/astro-iconset/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Astro Iconset
22

3+
[![npm version](https://img.shields.io/npm/v/astro-iconset?color=blue)](https://www.npmjs.com/package/astro-iconset)
4+
[![npm downloads](https://img.shields.io/npm/dm/astro-iconset)](https://www.npmjs.com/package/astro-iconset)
5+
[![license](https://img.shields.io/npm/l/astro-iconset)](./LICENSE)
6+
37
An [Astro integration](https://docs.astro.build/en/guides/integrations-guide/) that adds an `Icon` component for inlining SVGs at build time. Local files and [Iconify](https://iconify.design) sets are optimized with [SVGO](https://github.com/svg/svgo), repeated icons on a page share a sprite when not inlined, and nothing extra ships to the browser as a runtime.
48

59
**Features**
@@ -9,6 +13,19 @@ An [Astro integration](https://docs.astro.build/en/guides/integrations-guide/) t
913
- Optional `*.svg?icon` imports for one-off files without a shared directory
1014
- Wrapper components for React, Vue, Svelte, Preact, and Solid (install only what you use)
1115

16+
## Why astro-iconset?
17+
18+
| Feature | astro-iconset | astro-icon and others |
19+
| --- | --- | --- |
20+
| Local icons from `src/icons/` |||
21+
| Iconify collections |||
22+
| SVG sprite deduplication |||
23+
| Per-directory named prefixes |||
24+
| `?icon` import for one-off SVGs |||
25+
| React / Vue / Svelte / Preact / Solid |||
26+
| Zero browser runtime |||
27+
| SVGO optimization |||
28+
1229
- [Installation](#installation)
1330
- [Usage](#usage)
1431
- [Local icons](#local-icons)

0 commit comments

Comments
 (0)