diff --git a/README.md b/README.md index 2fea4bc287bde6..c39dd97bd37f91 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,12 @@ -

- MUI Core logo + + MUI Core logo +

MUI Core

-**MUI Core** contains foundational React UI component libraries for shipping new features faster: - -- [Material UI](https://mui.com/material-ui/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system. - -- [Joy UI](https://mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy. - -- [Base UI](https://mui.com/base-ui/) is a library of unstyled React UI components and hooks. With Base UI, you gain complete control over your app's CSS and accessibility features. - -- [MUI System](https://mui.com/system/getting-started/) is a collection of CSS utilities to help you rapidly lay out custom designs. - -
+**MUI Core** is your one-stop solution for building stunning React applications with ease. [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE) [![npm latest package](https://img.shields.io/npm/v/@mui/material/latest.svg)](https://www.npmjs.com/package/@mui/material) @@ -26,16 +17,26 @@ [![Follow on Twitter](https://img.shields.io/twitter/follow/MUI_hq.svg?label=follow+MUI)](https://twitter.com/MUI_hq) [![Renovate status](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/mui/material-ui/issues/27062) [![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mui/material-ui.svg)](https://isitmaintained.com/project/mui/material-ui 'Average time to resolve an issue') -[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/mui)](https://opencollective.com/mui) +[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/mui)](https://opencollective.com/mui) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1320/badge)](https://bestpractices.coreinfrastructure.org/projects/1320) -
+## What's Inside + +MUI Core offers a diverse set of UI libraries to cater to your needs: + +- [**Material UI**](https://mui.com/material-ui/): Embrace Google's [Material Design](https://m2.material.io/design/introduction/) system with a comprehensive library of components. + +- [**Joy UI**](https://mui.com/joy-ui/getting-started/): Experience joy in development with beautifully designed React UI components. + +- [**Base UI**](https://mui.com/base-ui/): Customize your app's CSS and accessibility features with unstyled React UI components and hooks. + +- [**MUI System**](https://mui.com/system/getting-started/): Speed up custom designs with a collection of CSS utilities. ## Documentation -### Material UI +Explore the full documentation for each library: -Visit [https://mui.com/material-ui/](https://mui.com/material-ui/) to view the full documentation. +- [**Material UI Documentation**](https://mui.com/material-ui/)
Older versions @@ -46,135 +47,64 @@ Visit [https://mui.com/material-ui/](https://mui.com/material-ui/) to view the f
-**Note:** `@next` only points to pre-releases. -Use `@latest` for the latest stable release. - -### Joy UI - -Visit [https://mui.com/joy-ui/getting-started/](https://mui.com/joy-ui/getting-started/) to view the full documentation. - -**Note**: Joy UI is still in beta. -We are adding new components regularly and you're welcome to contribute! - -### Base UI - -Visit [https://mui.com/base-ui/](https://mui.com/base-ui/) to view the full documentation. - -**Note**: Base UI is still in beta. -We are adding new components regularly and you're welcome to contribute! - -### MUI System - -Visit [https://mui.com/system/](https://mui.com/system/) to view the full documentation. +- [**Joy UI Documentation**](https://mui.com/joy-ui/getting-started/) +- [**Base UI Documentation**](https://mui.com/base-ui/) +- [**MUI System Documentation**](https://mui.com/system/) -## Sponsors +## Our Sponsors ### Diamond 💎

- octopus - doit + + octopus + + + doit +

Diamond Sponsors are those who have pledged \$1,500/month or more to MUI. ### Gold 🏆 -via [Open Collective](https://opencollective.com/mui) or via [Patreon](https://www.patreon.com/oliviertassinari) +Discover our Gold Sponsors via [Open Collective](https://opencollective.com/mui) or [Patreon](https://www.patreon.com/oliviertassinari).

- tidelift.com - text-em-all.com - Spotify - megafamous.com - dialmycalls.com - goread.io - Icons8 - ipinfo.ai + + tidelift.com + +

Gold Sponsors are those who have pledged \$500/month or more to MUI. -### More backers +### More Backers -See the full list of [our backers](https://mui.com/material-ui/discover-more/backers/). +View the full list of [our backers](https://mui.com/material-ui/discover-more/backers/). ## Questions -For how-to questions that don't involve making changes to the code base, please use [Stack Overflow](https://stackoverflow.com/questions/) instead of GitHub issues. +If you have how-to questions that don't involve code changes, please use [Stack Overflow](https://stackoverflow.com/questions/) instead of GitHub issues. ## Examples -Our documentation features [a collection of example projects](https://github.com/mui/material-ui/tree/master/examples). +Explore our [collection of example projects](https://github.com/mui/material-ui/tree/master/examples) in our documentation. -## Premium templates +## Premium Templates -You can find complete templates and themes in the [MUI Store](https://mui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store). +Find complete templates and themes in the [MUI Store](https://mui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store). ## Contributing -Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes. +Ready to contribute? Check out our [contributing guide](/CONTRIBUTING.md) to learn about our development process, propose bug fixes and improvements, and test your changes. -Contributing to MUI Core is about more than just issues and pull requests! -There are many other ways to [support MUI](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base. +Contributing to MUI Core is more than just coding. There are many other ways to [support MUI](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project). ## Changelog -The [changelog](https://github.com/mui/material-ui/releases) is regularly updated to reflect what's changed in each new release. +Stay up-to-date with the latest changes in our [changelog](https://github.com/mui/material-ui/releases). ## Roadmap -Future plans and high-priority features and enhancements can be found in our [roadmap](https://mui.com/material-ui/discover-more/roadmap/). - -## License - -This project is licensed under the terms of the -[MIT license](/LICENSE). - -## Security - -For details of supported versions and contact details for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy). - -## Sponsoring services - -These great services sponsor MUI's core infrastructure: - -
- - - - GitHub logo - - -[GitHub](https://github.com/) lets us host the Git repository and coordinate contributions. - -
- -
- - - - Netlify logo - - -[Netlify](https://www.netlify.com/) lets us distribute the documentation. - -
- -
- - - - BrowserStack logo - - -[BrowserStack](https://www.browserstack.com/) lets us test in real browsers. - -
- -
-CodeCov logo - -[CodeCov](https://about.codecov.io/) lets us monitor test coverage. - -
+Discover our future plans and high-priority features in our [roadmap