diff --git a/README.md b/README.md index 8ab13b6..0c273e3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,45 @@ # Semi.Avalonia +[![Semi Avalonia](https://img.shields.io/nuget/v/Semi.Avalonia.svg?color=red&style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/) +[![Semi Avalonia](https://img.shields.io/nuget/dt/Semi.Avalonia.svg?style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/) + Avalonia Theme inspired by Semi Design > Semi.Avalonia is still in very early stage. Please don't use in production. -> -> Dark theme is not designed at all. Please don't use that. -![Cover](./docs/cover.png) +# How to Use -## Requirement +## Installation +```bash +dotnet add package Semi.Avalonia --version 0.1.0-preview5 +``` +Include Semi Design Styles in application: -Avalonia V11 +```xaml + + + +``` +That's all. + +## Version compatibility + +|Semi Design Version| Avalonia Version| +|:---|:---| +|0.1.0-preview3|11.0-preview4| +|0.1.0-preview5|11.0-preview5| + +## TODO +* DataValidationErrors +* FocusAdorner +* DataGrid +* ColorPicker + +## Screenshot + +Light Mode +![Light](./docs/Light.png) + +Dark Mode +![Dark](./docs/Dark.png) \ No newline at end of file diff --git a/docs/Dark.png b/docs/Dark.png new file mode 100644 index 0000000..2ab3554 Binary files /dev/null and b/docs/Dark.png differ diff --git a/docs/Light.png b/docs/Light.png new file mode 100644 index 0000000..4ede880 Binary files /dev/null and b/docs/Light.png differ