docs: Update README.md with detailed project information

[taj54]

Summary by CodeRabbit

• Documentation

  • Added comprehensive contributing guidelines in a new CONTRIBUTING.md file.
  • Introduced a detailed developer guide in DEVELOPER.md, covering setup, project structure, scripts, and troubleshooting.
  • Expanded README.md with thorough package documentation, including features, installation, usage, props, development, and contribution sections.

• Refactor

  • Simplified build configuration for the project.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces two new documentation files: CONTRIBUTING.md and DEVELOPER.md, and significantly expands README.md with comprehensive user and contributor information. Additionally, the tsup.config.ts build configuration is refactored to export a direct configuration object, simplifying its structure and removing custom output extension logic.

Changes

Cohort / File(s)	Change Summary
Contributor & Developer Documentation CONTRIBUTING.md, DEVELOPER.md	Added new documentation files: CONTRIBUTING.md (contribution guidelines, code of conduct, commit conventions, etc.) and DEVELOPER.md (setup instructions, project structure, build/test scripts, troubleshooting).
User Documentation README.md	Expanded documentation with introduction, features, installation, usage examples, detailed props, development workflow, contributing, and licensing information. No code changes.
Build Configuration tsup.config.ts	Refactored build configuration: removed function wrapper, direct object export, eliminated outExtension and watch properties, and adjusted syntax accordingly. No changes to build entry points or output formats aside from the removed custom extensions and watch logic.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Docs
    participant BuildConfig

    Developer->>Docs: Reads CONTRIBUTING.md / DEVELOPER.md for guidance
    Developer->>Docs: References README.md for usage and props
    Developer->>BuildConfig: Runs build using simplified tsup.config.ts

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

• feat: Migrate tsup configuration to tsup.config.ts #6: Introduced the function-based tsup.config.ts configuration, which is directly refactored in this PR.

Poem

In the warren, docs now bloom,
Guides for every bunny’s room.
Build scripts trimmed, no more fuss,
Clearer paths for all of us.
With README shining, bright and neat—
Hop right in, the project’s sweet!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6860d20 and f101302.

📒 Files selected for processing (4)

• CONTRIBUTING.md (1 hunks)
• DEVELOPER.md (1 hunks)
• README.md (1 hunks)
• tsup.config.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.