simple-icons-astro/README.md

Get your Simple icons right into your Astro project

# Simple Icons Astro

<a href="https://discord.gg/MMbUAptxPr">
	<img src="https://img.shields.io/discord/1143555541004726272?color=%235865F2&label=Discord" alt="Discord Link">
</a>
<a href="https://github.com/dzeiocom/simple-icons-astro/stargazers">
	<img src="https://img.shields.io/github/stars/dzeiocom/simple-icons-astro?style=flat-square" alt="Github stars">
</a>
<a href="https://github.com/dzeiocom/simple-icons-astro/actions/workflows/build_publish.yml">
	<img src="https://img.shields.io/github/actions/workflow/status/dzeiocom/simple-icons-astro/build_publish.yml?style=flat-square" alt="Build passing" />
</a>

Astro library to get the Simple Icons to the Astro Framework

_We follow the Simple Icons versions for our release, with the exception of the patches_

## Installation

```
npm i simple-icons-astro
```

```
yarn add simple-icons-astro
```

## Usage

You can import each icons individually like below

```astro
---
import { Github } from 'simple-icons-astro'
---

<Layout>
	<Github />
</Layout>
```

## Compile

1. run `npm i` to install the dependencies
2. run `npm run build` to launch the build
3. done! you can publish it or use it as you like

## Attributions

Use the awesome icons from [Simple Icons](https://simpleicons.org/)

based on [lucide-astro](https://github.com/dzeiocom/lucide-astro)