docs: rework README and add full USAGE.md guide - #29
Merged
Conversation
Add a live-demo badge linking to material-ui-cron.vercel.app and drop the local demo-run instructions. Update install requirements to the current peer deps (react/react-dom >=19.2.0; @mui/material now bundled). Slim the README quick-start and move the prop-by-prop reference into a new USAGE.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Select a category
Related issue link
Background and solution
Reworks the README and adds a comprehensive
USAGE.mddocumenting every<Scheduler />prop with examples (controlled value, admin mode, theming/dark mode, layout, title, timezone, localization, multiple instances, and TypeScript). The README now carries a live-demo badge linking to https://material-ui-cron.vercel.app/ in place of the local demo-run instructions, slims the quick-start, and points readers to USAGE.md for the full guide. Installation requirements are updated to the current peer deps (react/react-dom>=19.2.0, with@mui/materialnow bundled as a dependency rather than a peer the user installs).🤖 Generated with Claude Code