[docs] Make the readme specific to @base_ui/react #633
Conversation
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
Netlify deploy preview |
atomiks
reviewed
Sep 18, 2024
README.md
Outdated
Comment on lines
35
to
36
| There are currently two Base UI libraries available on npm: [@base_ui/react](https://www.npmjs.com/package/@base_ui/react) (published from this repository) | ||
| and [@mui/base](https://www.npmjs.com/package/@mui/base) (published from https://github.com/mui/material-ui/tree/master/packages/mui-base). |
There was a problem hiding this comment.
There should probably be a note that the package name isn't final. I also think the note at the top could be better written to highlight the WIP status of this project and reduce confusion, and discourage using the old version
|
Changed the readme according to @colmtuite suggestion not to mention @mui/base. |
michaldudak
changed the title
atomiks
approved these changes
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The information in the README about the current state of the library was not clear (or even misleading).