Skip to content

docs: improve readme #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Fluent UI contribution packages 💪
# [Fluent UI Contrib](https://microsoft.github.io/fluentui-contrib/docsite)

This repository hosts packages that are published under the `@fluentui-contrib/` scope. Contributor packages
are extensions of [Fluent UI](https://github.com/microsoft/fluentui).
## Overview

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.

All packages in this repository are published under the `@fluentui-contrib/` npm scope and maintained by the Microsoft Fluent UI team with community contributions.

## Available Components & Libraries

| Controls/libraries | README | Docs | NPM |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -14,6 +19,18 @@ are extensions of [Fluent UI](https://github.com/microsoft/fluentui).
| 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) |
| 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) |

## Quick Start

To install a specific package:

```bash
# Using npm
npm install @fluentui-contrib/[package-name]

# Using yarn
yarn add @fluentui-contrib/[package-name]
```

## [Contributing](./Contributing.md)

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

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

## Trademarks

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