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

Feat(Components): Add more components for Readme #9

Open
6 tasks
narainkarthikv opened this issue Nov 9, 2024 · 0 comments
Open
6 tasks

Feat(Components): Add more components for Readme #9

narainkarthikv opened this issue Nov 9, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@narainkarthikv
Copy link
Owner

Enhance the README file by adding detailed documentation for existing and new components. This will improve usability and make it easier for developers to understand and use the components effectively.

Requirements

  1. Component Descriptions: Provide a brief description of each component’s purpose.
  2. Usage Examples: Include example code snippets for each component, showing how to integrate them into the project.
  3. Screenshots / GIFs: Add visuals to demonstrate component appearance and behavior.
  4. Props Table: List available props for each component, along with descriptions and default values (if applicable).
  5. Installation Instructions: If any additional dependencies are needed, include instructions on how to install them.

Additional Information

Ensure that the README structure is clear, with appropriate sections for each component. Make it beginner-friendly with proper headings and formatting.

Tasks

  • Add component descriptions to the README.
  • Provide example usage for each component.
  • Include screenshots or GIFs where necessary.
  • Create a props table for each component.
  • Update installation instructions (if required).
  • Review and refine the README for clarity and completeness.

Notes

This update aims to improve the documentation for easier onboarding and better accessibility to component usage details.

@narainkarthikv narainkarthikv added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant