Skip to content

Commit

Permalink
Update readme (#349)
Browse files Browse the repository at this point in the history
* Update readme

* Update README.md

Co-authored-by: J-P Nurmi <jp.nurmi@canonical.com>

* Update README.md

Co-authored-by: J-P Nurmi <jp.nurmi@canonical.com>

Co-authored-by: J-P Nurmi <jp.nurmi@canonical.com>
  • Loading branch information
Feichtmeier and jpnurmi committed Oct 26, 2022
1 parent 00a0994 commit 970ed1c
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,10 @@ Common flutter widgets useful for building desktop and web applications.
## What is this?

A set of convenient widgets made with `material.dart` to easily build desktop and web applications.
Design references are the [Ubuntu Yaru theme suite](https://github.com/ubuntu/yaru) and the [Vanilla framework](https://vanillaframework.io/) by Canonical.

[LIVE DEMO](https://ubuntu.github.io/yaru_widgets.dart/)

For example:

- `YaruMasterDetailPage`, for having a UI skeletton that adapts its navigation to the window width, with one layout for a wide/landscape window and one layout for a narrow/portrait window
- `YaruSection` for putting `Yaru*Row` widgets into a container with a rounded border and a headline
- `YaruTabbedPage`, for creating a tabbed view of pages with sane constraints and looks

## What it ain't

This is not:
Expand All @@ -32,6 +27,6 @@ The answer is that `material.dart` brings functionally everything that one needs

So `yaru_widgets.dart` uses the completeness and the level of polish `material.dart` has and adds a set of widgets to it that are useful (but not necessarily the only way) to build desktop and web applications so they all have a consistent look and use the same design patterns.

## Recommended themes
## Tested themes

Themes inside [`yaru.dart`](https://github.com/ubuntu/yaru.dart) are recommended but all flutter material themes should work.
Themes inside [`yaru.dart`](https://github.com/ubuntu/yaru.dart) are the only Material themes tested with yaru_widgets and we do not currently recommend to use any other themes.

0 comments on commit 970ed1c

Please sign in to comment.