docs: modernize and enhance README.md and CLAUDE.md - #10
Merged
kahwee merged 1 commit intoNov 10, 2025
Merged
Conversation
- Completely rewrite README.md with modern structure and comprehensive content - Add features section with clear value propositions - Add table of contents for easy navigation - Expand installation section with multiple package managers - Add detailed component examples with code snippets - Include comprehensive validation examples with Zod v4 - Add form composition patterns and API reference - Include contributing guidelines and development workflow - Better visual hierarchy with icons and formatting - Enhance CLAUDE.md for AI assistants and developers - Remove leftover PR description text from end of file - Update tech stack versions to match package.json (Vite v6.4+, etc.) - Better organize sections with clear hierarchy - Add detailed component documentation with props - Expand testing section with examples - Add Storybook documentation section - Include development workflow and code quality checklist - Add key principles section Both files now provide: - Modern, professional appearance - Clear, actionable documentation - Comprehensive examples and patterns - Better developer experience - Accurate version information matching actual tooling
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
2 participants
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.
Completely rewrite README.md with modern structure and comprehensive content
Enhance CLAUDE.md for AI assistants and developers
Both files now provide: