Skip to content

Commit f8fec4f

Browse files
doc(readme): update some content for release (#123)
1 parent 8ded230 commit f8fec4f

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
The `Microsoft.Fast.Components.FluentUI` package provides a lightweight set of [Blazor](https://blazor.net) component wrappers around Microsoft's official FluentUI Web Components. The FluentUI Web Components are built on [FAST](https://www.fast.design/) and work in every major browser. To get up and running with `Microsoft.Fast.Components.FluentUI` see the Getting Started section below.
1818

19-
The source for `@fluentui/web-components` is hosted in the [Fluent UI](https://github.com/microsoft/fluentui/tree/master/packages/web-components) mono-repository. An implementation of current Fluent Web Components can be found at https://aka.ms/fluentwebcomponents.
19+
The source for `@fluentui/web-components` is hosted in the [Fluent UI](https://github.com/microsoft/fluentui/tree/master/packages/web-components) mono-repository. Documentation on the components is available on [docs.microsoft.com](https://docs.microsoft.com/en-us/fluent-ui/web-components/).
2020

2121
## Getting Started
2222

@@ -41,16 +41,32 @@ Depending on what type of Blazor project you are building, it will go into one o
4141
4242
Once these steps are completed, you can then begin using the components throughout your Blazor application by adding the following `using` statement to your views:
4343

44-
```cs
44+
```razor
4545
@using Microsoft.Fast.Components.FluentUI
4646
```
4747

48+
Here's an example of what page with a card and button would look like:
49+
50+
```razor
51+
@page "/"
52+
@using Microsoft.Fast.Components.FluentUI
53+
54+
<FluentCard>
55+
<h2>Hello World!</h2>
56+
<FluentButton Appearance="@Appearance.Accent">
57+
Click Me
58+
</FluentButton>
59+
</FluentCard>
60+
```
61+
4862
Take a look in the `examples` folder of this repository to see how to use the various components.
4963

5064
## Joining the Community
5165

5266
Looking to get answers to questions or engage with us in realtime? Our community is most active [on Discord](https://discord.gg/FcSNfg4). Submit requests and issues on [GitHub](https://github.com/dotnet/blazor-fluentui/issues/new/choose), or join us by contributing on [some good first issues via GitHub](https://github.com/dotnet/blazor-fluentui/labels/community:good-first-issue).
5367

68+
If you don't find a component you're looking for, it's best to create the issue in our FAST repo [here](https://github.com/microsoft/fast) and limit issues on this repo to bugs in the Blazor component wrappers or Blazor-specific features.
69+
5470
We look forward to building an amazing open source community with you!
5571

5672
## Contact

0 commit comments

Comments
 (0)