Skip to content

Commit 0eb8f91

Browse files
authored
docs: improve readme (#386)
1 parent 10c358e commit 0eb8f91

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# Fluent UI contribution packages 💪
1+
# [Fluent UI Contrib](https://microsoft.github.io/fluentui-contrib/docsite)
22

3-
This repository hosts packages that are published under the `@fluentui-contrib/` scope. Contributor packages
4-
are extensions of [Fluent UI](https://github.com/microsoft/fluentui).
3+
## Overview
4+
5+
Fluent UI Contrib is an official collection of extensions and components that enhance [Fluent UI](https://github.com/microsoft/fluentui). These packages provide additional functionality that complements the core Fluent UI library, helping you build rich, consistent user experiences with less code.
6+
7+
All packages in this repository are published under the `@fluentui-contrib/` npm scope and maintained by the Microsoft Fluent UI team with community contributions.
8+
9+
## Available Components & Libraries
510

611
| Controls/libraries | README | Docs | NPM |
712
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -14,6 +19,18 @@ are extensions of [Fluent UI](https://github.com/microsoft/fluentui).
1419
| houdini-utils | [README.md](https://github.com/microsoft/fluentui-contrib/blob/main/packages/houdini-utils/README.md) | [Storybook](https://microsoft.github.io/fluentui-contrib/react-houdini-utils) | [![npm version](https://img.shields.io/npm/v/@fluentui-contrib/houdini-utils?style=flat-square)](https://www.npmjs.com/package/@fluentui-contrib/houdini-utils) |
1520
| react-draggable-dialog | [README.md](https://github.com/microsoft/fluentui-contrib/blob/main/packages/react-draggable-dialog/README.md) | [Storybook](https://microsoft.github.io/fluentui-contrib/react-draggable-dialog) | [![npm version](https://img.shields.io/npm/v/@fluentui-contrib/react-draggable-dialog?style=flat-square)](https://www.npmjs.com/package/@fluentui-contrib/react-draggable-dialog) |
1621

22+
## Quick Start
23+
24+
To install a specific package:
25+
26+
```bash
27+
# Using npm
28+
npm install @fluentui-contrib/[package-name]
29+
30+
# Using yarn
31+
yarn add @fluentui-contrib/[package-name]
32+
```
33+
1734
## [Contributing](./Contributing.md)
1835

1936
Please read the [CONTRIBUTING.md file](./CONTRIBUTING.md) for instructions on how to onboard to the repository and
@@ -31,6 +48,10 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
3148
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
3249
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
3350

51+
## License
52+
53+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
54+
3455
## Trademarks
3556

3657
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft

0 commit comments

Comments
 (0)