Skip to content

Commit

Permalink
Improve readme (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
digitaldirk authored Sep 20, 2024
1 parent 5bce662 commit ec6e1dd
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# ![MudBlazor](content/MudBlazor-GitHub-NoBg.png)
<h1>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="content/MudBlazor-GitHub-NoBg-Dark.png">
<source media="(prefers-color-scheme: light)" srcset="content/MudBlazor-GitHub-NoBg.png">
<img alt="MudBlazor" src="content/MudBlazor-GitHub-NoBg.png">
</picture>
</h1>

# Theme Manager / Generator for MudBlazor

[![GitHub](https://img.shields.io/github/license/garderoben/mudblazor?color=594ae2&style=flat-square&logo=github)](https://github.com/Garderoben/MudBlazor.ThemeManager/blob/master/LICENSE)
Expand All @@ -8,13 +15,13 @@

Blazor Theme Manager component for MudBlazor library. Can be used live or during development to fast and easy try out different theme settings.

**This component is not suitable for prod applications, be ready for performance issues, bugs and missing features. Feel free to help improve it.**
**This component is currently not suitable for production applications, be ready for performance issues, bugs and missing features. Feel free to help improve it.**

## Workflow
![caption](content/WorkFlow_DarkTheme.webp)

## Prerequisites
- [MudBlazor](https://mudblazor.com/) Installed and configurated.
- [MudBlazor](https://www.mudblazor.com/getting-started/installation) Installed and configurated.
## Installation
Install Package
```
Expand All @@ -24,7 +31,7 @@ Add the following to `_Imports.razor`
```razor
@using MudBlazor.ThemeManager
```
Add the following to `index.html` (client-side) or `_Host.cshtml` (server-side) in the `head`
Add the following to your HTML `head` section, it's either `index.html` or `_Layout.cshtml`/`_Host.cshtml`/`App.razor` depending on whether you're running WebAssembly or Server.
```razor
<link href="https://fonts.googleapis.com/css2?family=Ubuntu:wght@300;400;500;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap" rel="stylesheet">
Expand Down
Binary file added content/MudBlazor-GitHub-NoBg-Dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ec6e1dd

Please sign in to comment.