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] Explain the difference between @mui/base and @base_ui/react #633

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

michaldudak
Copy link
Member

The information in the README about the current state of the library was not clear (or even misleading).

@michaldudak michaldudak added the docs Improvements or additions to the documentation label Sep 18, 2024
@mui-bot
Copy link

mui-bot commented Sep 18, 2024

Netlify deploy preview

https://deploy-preview-633--base-ui.netlify.app/

Generated by 🚫 dangerJS against fb5ef15

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants