anupammaurya6767 / luffy

Luffy: whatsapp group management bot with link to drive upload feature and many more functionalities
https://x.com/anupammaurya981/status/1772310401327231002
19 stars 23 forks source link

Write a Readme for the project #9

Closed anupammaurya6767 closed 4 weeks ago

anupammaurya6767 commented 2 months ago

Is your feature request related to a problem? Please describe. The project currently lacks a comprehensive Readme file, which is essential for new contributors to understand the project and how to set it up locally.

Describe the solution you'd like Create a Readme.md file that provides an overview of the project, including its purpose, features, setup instructions, configuration, and usage guidelines.

Describe alternatives you've considered An alternative could be creating separate documents for specific sections of the Readme, but a single comprehensive Readme.md file would be more user-friendly.

Additional context Adding a Readme.md file will improve the project's documentation and make it easier for contributors to get started with the project.

yashisrani commented 2 months ago

@anupammaurya6767 kindly assign me this issue under #gssoc'24 .. I will Enhance Readme file and make it beautiful , clear and usable for other folks ..

anupammaurya6767 commented 2 months ago

@yashisrani go ahead

IP80808080 commented 1 month ago

👋 Hello! I'd be happy to help with this issue. Could you please assign it to me? Thank you! 🚀

harini-1597 commented 1 month ago

Hi. Noticed this issue is still not resolved as the README is still just two lines. Could you assign it to me? I'll have it done asap

anupammaurya6767 commented 1 month ago

@harini-1597 go ahead

harini-1597 commented 1 month ago

How does this look?

https://github.com/anupammaurya6767/luffy/assets/128628820/b7f9f61a-6db7-4a8c-8e21-cc5e4911812d

anupammaurya6767 commented 1 month ago

@harini-1597 nice create a pull request