diff --git a/README.md b/README.md index 07bf9df1..169fd16d 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,45 @@ # ![MudBlazor](content/MudBlazor-GitHub-NoBg.png) -# Blazor Project Templates built with MudBlazor +# Blazor Templates pre configured with MudBlazor. [![GitHub](https://img.shields.io/github/license/garderoben/mudblazor?color=%23594ae2&style=flat-square)](https://github.com/Garderoben/MudBlazor.Templates/blob/master/LICENSE) [![Discord](https://img.shields.io/discord/786656789310865418?color=%237289da&label=Discord&logo=discord&logoColor=%237289da&style=flat-square)](https://discord.gg/mudblazor) [![Twitter](https://img.shields.io/twitter/follow/MudBlazor?color=1DA1F2&label=Twitter&logo=Twitter&style=flat-square)](https://twitter.com/MudBlazor) -[![Nuget version](https://img.shields.io/nuget/v/MudBlazor.Template.DefaultBlazor?color=ff4081&label=nuget%20version&logo=nuget&style=flat-square)](https://www.nuget.org/packages/MudBlazor.Template.DefaultBlazor/) -[![Nuget downloads](https://img.shields.io/nuget/dt/MudBlazor.Template.DefaultBlazor?color=ff4081&label=nuget%20downloads&logo=nuget&style=flat-square)](https://www.nuget.org/packages/MudBlazor.Template.DefaultBlazor/) - - -In this repo you will find project templates for Blazor built with just MudBlazor. The idea is to provide templates that range from a basic layout to more advanced application setups. It's an excellent place to get started with MudBlazor. - -[Live demo](https://templates.mudblazor.com/) - -**Note: Make sure to upgrade the MudBlazor nuget references to the newest version!** If you can, please PR the nuget upgrade, so this repo is kept up to date with MudBlazor. +[![Nuget version](https://img.shields.io/nuget/v/MudBlazor.Templates?color=ff4081&label=nuget%20version&logo=nuget&style=flat-square)](https://www.nuget.org/packages/MudBlazor.Templates/) +[![Nuget downloads](https://img.shields.io/nuget/dt/MudBlazor.Templates?color=ff4081&label=nuget%20downloads&logo=nuget&style=flat-square)](https://www.nuget.org/packages/MudBlazor.Templates/) ## Prerequisites -- .NET 5 -- Visual Studio 2019 with the ASP.NET and Web development. - -## MudBlazor -For more information about Mudblazor, stop by our main repo or visit our website. -- [Github repository](https://github.com/Garderoben/MudBlazor) -- [MudBlazor website](https://mudblazor.com) - -## Default Blazor Template +- .NET 5 / .NET 6 +- Visual Studio 2019/2022 with the ASP.NET and Web development. + +## Getting Started +### Installation +``` +dotnet new --install MudBlazor.Templates +``` +### Usage +``` +dotnet new mudblazor --host wasm --name MyApplication +``` +### Template Options +Specific template options: +| Options | Description | Type | Default | +|-------------------------|-------------------------------------------------------|------------------------------------------------------------------------------|-----------| +| `-ho` \| `--host` | Project Type | `wasm` \| `wasm-hosted`
`wasm-pwa` \| `wasm-pwa-hosted`
`server`
| `wasm` | +| `-t` \| `--template` | MudBlazor Template Variant | `default` \| `admindashboard` | `default` | +| `-s` \| `--skipRestore` | Skips the automatic restore of the project on create. | `bool` | `false` | + +For none MudBlazor specific options run: +``` +dotnet new -h +``` + +### Visual Studio Templates +The templates can be used in Visual Studio as well and should show up in the list when creating a new project. +![VisualStudioTemplate](content/visual-studio-template.png) + +## Template - Default Blazor ![DefaultBlazorTemplate](content/DefaultBlazorTemplate.png) -## Admin Dashboard Template +## Template - Admin Dashboard ![AdminDashboardTemplate](content/AdminDashboardTemplate.png) - -## License - -These Templates are free to use!