-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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] Add more information to readme #539
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,38 @@ | ||
| # Material-UI X | ||
| <p align="center"> | ||
| <a href="https://material-ui.com/" rel="noopener" target="_blank"><img width="150" src="https://material-ui.com/static/logo.svg" alt="Material-UI logo"></a></p> | ||
| </p> | ||
|
|
||
| <h1 align="center">Material-UI X</h1> | ||
|
|
||
| The Material-UI X mono-repo gathers Material-UI advanced components. | ||
|
|
||
| ## Components | ||
|
|
||
| - [DataGrid](https://material-ui.com/components/data-grid/) | ||
|
|
||
| ## Questions | ||
|
|
||
| For _how-to_ questions and other non-issues, | ||
| please use [StackOverflow](https://stackoverflow.com/questions/tagged/material-ui) instead of GitHub issues. | ||
| There is a StackOverflow tag called "material-ui" that you can use to tag your questions. | ||
|
|
||
| ## Examples | ||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Are you looking for an example project to get started? | ||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [We host some](https://material-ui.com/getting-started/example-projects/). | ||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Contributing | ||
|
|
||
| Read our [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 Material-UI. | ||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Notice that contributions go far beyond pull requests and commits. | ||
| Although we love giving you the opportunity to put your stamp on Material-UI, we also are thrilled to receive a variety of [other contributions](https://material-ui.com/getting-started/faq/#material-ui-is-awesome-how-can-i-support-the-project). | ||
|
|
||
| ## Changelog | ||
|
|
||
| Recently Updated? | ||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Please read the [changelog](https://github.com/mui-org/material-ui-x/releases). | ||
oliviertassinari marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Roadmap | ||
|
|
||
| The future plans and high priority features and enhancements can be found in the [roadmap](https://material-ui.com/discover-more/roadmap/) file. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we link to the paid version with reference to the included support?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "Pro" plan, the only one we sell yet, has no dedicated support attached to it. Proper support is in the "Premium" plan, and more expensive.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But maybe we can clarify it here, yes +1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the wireframe it comes with a year of support.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was referring to:
in which I believe we provide support as GitHub issues :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So was I, but let's park it for another time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Considering "Pro" have priority over "Community" on GitHub, I 👍 the original comment.