parthasdey2304 / React-Components

This repo contains all the React Components that I can use anytime as Legos to make a plug and play website.
MIT License
8 stars 7 forks source link

Update the README.md file #5

Open parthasdey2304 opened 14 hours ago

parthasdey2304 commented 14 hours ago

Add a README.md File for the Repository

Description:

We currently lack a README.md file in this repository, which is essential for providing an overview of the project and setting expectations for contributors and users.

The goal of this issue is to create a professional and comprehensive README.md file that clearly communicates the following points:

Requirements:

Suggested Structure:

  1. Project Title
  2. Overview
  3. Technologies Used
  4. Installation
  5. Usage
  6. Contributing
  7. License
  8. Contact Information

Please refer to similar open-source repositories for inspiration on structure and content. We look forward to your contribution!

Note: Make sure to follow the repository's code of conduct and guidelines when submitting a pull request. And do add a screenshot of the README.md file with the commit!

Thank you for helping improve the documentation!

ChiefBibek commented 11 hours ago

The work is done. Open to discuss about any changes to add on

parthasdey2304 commented 8 hours ago

You didn't add a screenshot of the changes that you have made. @ChiefBibek I would appreciate if you read the Note at the end of the Issue description.

parthasdey2304 commented 8 hours ago

@ChiefBibek I went through your PR. We need to change the Directory structure as well so that it contains only the components. You can refer to DaisyUI, Flowbite, etc.