|
| 1 | +# ShellUI v0.1.0 🎉 |
| 2 | + |
| 3 | +> Beautiful, accessible Blazor components inspired by shadcn/ui |
| 4 | +
|
| 5 | +## ✨ Highlights |
| 6 | + |
| 7 | +This is the **first official release** of ShellUI - a CLI-first Blazor component library that brings the shadcn/ui philosophy to .NET developers. |
| 8 | + |
| 9 | +### 🚀 What's Included |
| 10 | + |
| 11 | +#### CLI Tool (`ShellUI.CLI`) |
| 12 | +- **`shellui init`** - Initialize your Blazor project with Tailwind CSS |
| 13 | +- **`shellui add <component>`** - Add individual components to your project |
| 14 | +- **`shellui list`** - List all available components |
| 15 | +- **`shellui remove <component>`** - Remove installed components |
| 16 | +- **`shellui update`** - Update components to the latest version |
| 17 | + |
| 18 | +#### Components Library (`ShellUI.Components`) |
| 19 | +Pre-built components for NuGet installation: |
| 20 | +- **Button** - Interactive button with variants (default, destructive, outline, secondary, ghost, link) |
| 21 | +- **Badge** - Status indicators with multiple variants |
| 22 | +- **Alert** - Notification banners with icons |
| 23 | +- **Card** - Content containers with header, content, and footer sections |
| 24 | +- **Input** - Form input fields |
| 25 | +- **Label** - Accessible form labels |
| 26 | +- **Separator** - Visual dividers |
| 27 | +- **Shell utilities** - `Shell.Cn()` for Tailwind class merging |
| 28 | + |
| 29 | +## 📦 Installation |
| 30 | + |
| 31 | +### Option 1: CLI (Recommended) |
| 32 | +```bash |
| 33 | +# Install the CLI globally |
| 34 | +dotnet tool install -g ShellUI.CLI |
| 35 | + |
| 36 | +# Initialize your project |
| 37 | +shellui init |
| 38 | + |
| 39 | +# Add components |
| 40 | +shellui add button badge alert card |
| 41 | +``` |
| 42 | + |
| 43 | +### Option 2: NuGet Package |
| 44 | +```bash |
| 45 | +dotnet add package ShellUI.Components |
| 46 | +``` |
| 47 | + |
| 48 | +## 🎨 Styling |
| 49 | + |
| 50 | +ShellUI uses **Tailwind CSS v4** with CSS variables for theming. The `shellui init` command automatically sets up: |
| 51 | +- Tailwind CSS standalone CLI (no Node.js required) |
| 52 | +- CSS variables for light/dark themes |
| 53 | +- Component styling aligned with shadcn/ui |
| 54 | + |
| 55 | +## 📋 Requirements |
| 56 | + |
| 57 | +- .NET 9.0 or later |
| 58 | +- Blazor Server, WebAssembly, or Interactive modes |
| 59 | + |
| 60 | +## 🔗 Links |
| 61 | + |
| 62 | +- **Documentation**: https://shellui.dev |
| 63 | +- **GitHub**: https://github.com/shellui-dev/shellui |
| 64 | +- **NuGet**: https://www.nuget.org/packages/ShellUI.Components |
| 65 | + |
| 66 | +## 🙏 Acknowledgments |
| 67 | + |
| 68 | +Inspired by [shadcn/ui](https://ui.shadcn.com/) - the beautiful React component library. |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +**Full Changelog**: https://github.com/shellui-dev/shellui/commits/v0.1.0 |
0 commit comments