Skip to content

Commit

Permalink
feat: update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
rabbitism committed Jul 2, 2023
1 parent 2854564 commit 9513d79
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,46 @@
<img src="./assets/Ursa.svg" alt="drawing" width="150" />
</p>

Ursa is a UI library for building cross-platform UIs with Avalonia UI.
Ursa is a UI library for building cross-platform UIs with Avalonia UI.

## How to use
1. Ursa

Add nuget package:
```bash
dotnet add package Irihi.Ursa --version 0.1.0-beta20230702
```

You can now use Ursa controls in your Avalonia Application.
```xaml
<Window
...
xmlns:u="https://irihi.tech/ursa"
...>
<StackPanel Margin="20">
<u:ButtonGroup Classes="Solid Warning">
<Button Content="Hello" />
<Button Content="World" />
</u:ButtonGroup>
<u:TagInput />
</StackPanel>
</Window>
```

2. Ursa.Themes.Semi

To make Ursa controls show up in your application, you need to reference to a theme package designed for Ursa.
Ursa.Themes.Semi is a theme package for Ursa inspired by Semi Design. You can add it to your project by following steps.

Add nuget package:
```bash
dotnet add package Irihi.Ursa.Themes.Semi --version 0.1.0-beta20230702
```

Include Styles in application:
```xaml
<Application.Styles>
<StyleInclude Source="avares://Semi.Avalonia/Themes/Index.axaml" />
<StyleInclude Source="avares://Ursa.Themes.Semi/Index.axaml" />
</Application.Styles>
```

0 comments on commit 9513d79

Please sign in to comment.