Skip to content
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

[docs] Update README.md to match Introduction section of the docs #5754

Merged
merged 9 commits into from
Sep 1, 2022
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
116 changes: 81 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,63 +5,109 @@

<h1 align="center">MUI X</h1>

The [main repository](https://github.com/mui/material-ui) of MUI focuses on providing a ready-to-use design system, as well as empowering developers to build their own.
MUI X is a collection of advanced UI components, including a [data grid](https://mui.com/x/react-data-grid/) and [date and time pickers](https://mui.com/x/react-date-pickers/getting-started/).

This MUI X mono-repo gathers the advanced MUI components – it's an extension of the core.
The fundamental features are MIT licensed, and the more advanced ones commercial.
These components are significantly more complex than the ones found in the [MUI Core](https://github.com/mui/material-ui/) libraries.
They feature advanced functionality for data-rich applications and a wide range of other use cases.

MUI X is **open core**—base components are MIT-licensed, while more advanced features require a Pro or Premium commercial license.
See the [Licensing page](https://mui.com/x/introduction/licensing/) for details.

## Components

- [Data grid](https://mui.com/x/react-data-grid/)
- [Date / Time pickers](https://mui.com/x/react-date-pickers/getting-started/)
- [Data Grid](https://mui.com/x/react-data-grid/)
- [Date and Time Pickers](https://mui.com/x/react-date-pickers/getting-started/)
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

## How do we decide if a feature is MIT or commercial?
## Installation

We have been building MIT React components since 2014,
and have learned much about the strengths and weaknesses of the MIT license model.
The health of this model is improving every day.
As the community grows, it increases the probability that developers contribute improvements to the project.
You can find our pledge to nurture the MIT licensed content on [this Stewardship page](https://mui-org.notion.site/Stewardship-542a2226043d4f4a96dfb429d16cf5bd).
### Data Grid
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

However, we believe that we have reached the sustainability limits of what the model can support for advancing our mission forward.
We have seen too many MIT licensed components moving slowly or getting abandoned.
The community isn't contributing improvements as fast as the problems deserved to be solved.
Read the Data Grid [Installation instructions](https://mui.com/x/react-data-grid/getting-started/#installation) in the MUI X docs.

We are using a commercial license to forward the development of the most advanced features, where the MIT model can't sustain it.
A feature should only be commercial if it has no great MIT alternatives.
### Date and Time Pickers
samuelsycamore marked this conversation as resolved.
Show resolved Hide resolved

Find more details [in the docs](https://mui.com/x/introduction/licensing/).
Read the Date and Time Pickers [Installation instructions](https://mui.com/x/react-date-pickers/getting-started/#setup) in the MUI X docs.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

- [DataGrid](https://mui.com/components/data-grid/), published under `@mui/x-data-grid`, MIT licensed.
- [DataGridPro](https://mui.com/components/data-grid/#commercial-version), published under `@mui/x-data-grid-pro`, commercially licensed.
- [DataGridPremium](https://mui.com/components/data-grid/#commercial-version), published under `@mui/x-data-grid-premium`, commercially licensed.
## MIT vs. commercial licenses

## Questions
MUI has been building MIT-licensed React components since 2014, and we are committed to the continued advancement of the open-source libraries.
Anything we release under an MIT license will remain MIT-licensed forever.
You can learn more about our stewardship ethos in [this document from our company handbook](https://mui-org.notion.site/Stewardship-542a2226043d4f4a96dfb429d16cf5bd).

For _how-to_ questions and other non-issues,
please use [Stack Overflow](https://stackoverflow.com/questions/tagged/mui) instead of GitHub issues.
There is a Stack Overflow tag called "mui" that you can use to tag your questions.
We offer commercial licenses to developers who need the most advanced features that cannot be easily maintained by the open-source community.
Commercial licenses enable us to support a full-time staff of engineers, which is simply not possible through the MIT model.

## Bugs or feature request
Rest assured that when we release features commercially, it's only because we believe that you will not find a better MIT-licensed alternative anywhere else.

You can create an [issue](https://github.com/mui/mui-x/issues) on this repository.
Please always provide a reproduction case, the following templates can be a good start:
See the [Pricing](https://mui.com/pricing/) page for a detailed feature comparison.

## Plans

### Community Plan

The free version of MUI X is [published under an MIT license](https://tldrlegal.com/license/mit-license) and is [free forever](https://mui-org.notion.site/Stewardship-542a2226043d4f4a96dfb429d16cf5bd#20f609acab4441cf9346614119fbbac1).
This version contains features that we believe are maintainable by contributions from the open-source community.

MIT licensed packages:

- [`@mui/x-data-grid`](https://www.npmjs.com/package/@mui/x-data-grid)
- [`@mui/x-date-pickers`](https://www.npmjs.com/package/@mui/x-date-pickers)

### Pro Plan

The Pro version of MUI X expands on the features of the free version with more advanced capabilities such as multi-filtering, multi-sorting, column resizing and column pinning for the data grid; as well as the date range picker component.

The Pro version is available under a commercial license—visit [the Pricing page](https://mui.com/pricing/) for details.

Pro packages:

- [`@mui/x-data-grid-pro`](https://www.npmjs.com/package/@mui/x-data-grid-pro)
- [`@mui/x-date-pickers-pro`](https://www.npmjs.com/package/@mui/x-date-pickers-pro)

### Premium Plan

- [DataGrid community version](https://codesandbox.io/s/datagrid-v5-quick-start-54iz1)
- [DataGridPro commercial version](https://codesandbox.io/s/datagridpro-v5-quick-start-5pjhc)
- [DataGridPremium commercial version](https://codesandbox.io/s/datagridpremium-v5-quick-start-h2ztp2)
The Premium version of MUI X covers the most advanced features of the data grid, such as row grouping, Excel export, and aggregation, in addition to everything that's included in the Pro Plan.

The Premium version is available under a commercial license—visit [the Pricing page](https://mui.com/pricing/) for details.

Premium package:

- [`@mui/x-data-grid-premium`](https://www.npmjs.com/package/@mui/x-data-grid-premium)

## Questions and feedback

### GitHub

We use GitHub issues as a bug and feature request tracker.
If you think you've found a bug, or you have a new feature idea, please start by [making sure it hasn't already been reported or fixed](https://github.com/mui/mui-x/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aclosed).
You can search through existing issues and pull requests to see if someone has reported one similar to yours.

[Open an issue](https://github.com/mui/mui-x/issues/new/choose) in the MUI X repo.

### Stack Overflow

Visit Stack Overflow to ask questions and read crowdsourced answers from expert developers in the MUI community, as well as MUI maintainers.

[Post a question about MUI X](https://stackoverflow.com/questions/tagged/mui) on Stack Overflow using the "mui" tag.

### Bugs and feature requests

You can create an [issue](https://github.com/mui/mui-x/issues) on this repository.
Please always provide a reproduction case.
As a starting point, we recommend you [browse the documentation](https://mui.com/x/introduction/), and [select](https://mui.com/static/docs/forking-an-example.png) the closest example to your use case.
Or you can use a [basic template](https://mui.com/r/x-issue-template) to build your reproduction case.

## Contributing

Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to MUI X.
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.

Notice that contributions go far beyond pull requests and commits.
Although we love giving you the opportunity to put your stamp on MUI, we also are thrilled to receive a variety of [other contributions](https://mui.com/getting-started/faq/#material-ui-is-awesome-how-can-i-support-the-project).
Contributing to MUI X 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.

## Changelog

If you have recently updated, please read the [changelog](https://github.com/mui/mui-x/releases) for details of what has changed.
The [changelog](https://github.com/mui/mui-x/releases) is regularly updated to reflect what's changed in each new release.

## Roadmap

The future plans and high priority features and enhancements can be found in the [roadmap](https://mui.com/discover-more/roadmap/) file.
Future plans and high-priority features and enhancements can be found in our [roadmap](https://mui.com/x/introduction/roadmap/).