Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dme-compunet committed Dec 26, 2024
1 parent b2c9d77 commit a66cf57
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,40 @@
# ✨ Lucide.Avalonia

Implementation of the [Lucide](https://github.com/lucide-icons/lucide) icon library for [AvaloniaUI](https://github.com/AvaloniaUI/Avalonia).
Implementation of the [Lucide icon library](https://github.com/lucide-icons/lucide) for [AvaloniaUI](https://github.com/AvaloniaUI/Avalonia).

[![NuGet Version](https://img.shields.io/nuget/v/Lucide.Avalonia?logo=nuget)](https://www.nuget.org/packages/Lucide.Avalonia)
[![GitHub License](https://img.shields.io/github/license/dme-compunet/Lucide.Avalonia)](https://github.com/dme-compunet/Lucide.Avalonia/blob/main/LICENSE)

# Examples
---

## ⚡ Advantages

- **No styles include required** – it works out of the box.
- **No xmlns declaration required** – just add and use.

---

## 🚀 Usage Examples

### Using the `LucideIcon` Element

```xml
<LucideIcon Kind="Star"/>
<LucideIcon Kind="Star" Size="30"/>
<LucideIcon Kind="Star" Size="30" StrokeWidth="1.5"/>
```

Markup Extension
### Using a Markup Extension

```xml
<Button Content="{LucideIconContent Star}"/>
<Button Content="{LucideIconContent Star, 30, 1.5}"/>
<Button Content="{LucideIconContent Kind=Star, Size=30, StrokeWidth=1.5}"/>
```

---

## 🔗 Additional Links

- [Lucide Icons](https://lucide.dev/icons)
- [NuGet Package](https://www.nuget.org/packages/Lucide.Avalonia)

0 comments on commit a66cf57

Please sign in to comment.