Skip to content

Commit 3c4b02c

Browse files
authored
feat: Release/v0.1.0 (#5)
2 parents 1d68fbe + 2f77f2b commit 3c4b02c

File tree

6 files changed

+115
-328
lines changed

6 files changed

+115
-328
lines changed

.github/workflows/release.yml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ on:
55
tags:
66
- 'v*.*.*'
77

8+
permissions:
9+
contents: write
10+
811
jobs:
912
publish:
1013
runs-on: ubuntu-latest
@@ -29,9 +32,27 @@ jobs:
2932
run: dotnet test --no-restore --configuration Release
3033

3134
- name: Pack NuGet packages
32-
run: dotnet pack --no-restore --configuration Release
35+
run: dotnet pack --no-build --configuration Release -p:ContinuousIntegrationBuild=true
3336

3437
- name: Publish to NuGet
3538
run: |
3639
dotnet nuget push **/*.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
3740
dotnet nuget push **/*.snupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
41+
42+
- name: Extract version from tag
43+
id: version
44+
run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
45+
46+
- name: Create GitHub Release
47+
uses: softprops/action-gh-release@v2
48+
with:
49+
name: ShellUI v${{ steps.version.outputs.VERSION }}
50+
body_path: docs/RELEASE_NOTES.md
51+
draft: false
52+
prerelease: ${{ contains(github.ref, '-') }}
53+
files: |
54+
src/ShellUI.CLI/bin/Release/*.nupkg
55+
src/ShellUI.Components/bin/Release/*.nupkg
56+
src/ShellUI.Core/bin/Release/*.nupkg
57+
env:
58+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
# ShellUI
1+
<p align="center">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" srcset="images/Shellui-dark.png">
4+
<source media="(prefers-color-scheme: light)" srcset="images/Shellui-light.png">
5+
<img alt="ShellUI Logo" src="images/Shellui-light.png" width="120">
6+
</picture>
7+
</p>
8+
9+
<h1 align="center">ShellUI</h1>
10+
11+
<p align="center">
12+
A modern, CLI-first Blazor component library inspired by <a href="https://ui.shadcn.com/">shadcn/ui</a>.<br/>
13+
Copy components directly into your project and customize them to match your needs.
14+
</p>
15+
16+
<p align="center">
17+
<a href="https://www.nuget.org/packages/ShellUI.Components"><img src="https://img.shields.io/nuget/v/ShellUI.Components?style=flat-square&logo=nuget&color=004880" alt="NuGet"></a>
18+
<a href="https://www.nuget.org/packages/ShellUI.CLI"><img src="https://img.shields.io/nuget/v/ShellUI.CLI?style=flat-square&logo=nuget&label=CLI&color=004880" alt="CLI"></a>
19+
<a href="https://github.com/shellui-dev/shellui/blob/main/LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="License"></a>
20+
</p>
221

3-
A modern, CLI-first Blazor component library inspired by shadcn/ui. Copy components directly into your project and customize them to match your needs.
22+
---
423

524
**New here? Check out the [Quick Start](#quick-start) section below!**
625

docs/RELEASE_NOTES.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
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

Comments
 (0)