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

Update readme #2

Open
VarunGitGood opened this issue Jun 2, 2023 · 3 comments
Open

Update readme #2

VarunGitGood opened this issue Jun 2, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@VarunGitGood
Copy link
Collaborator

VarunGitGood commented Jun 2, 2023

Well let's start off with this

Create a readme.md 💯

  • should include how to setup the project and run it locally
  • A few points about the project and its impact

This is created using vite, refer to package.json to checkout the scripts and update them accordingly
also since each PR runs a lint and prettier:format check add that too, later will add Husky to generalize it
Feel free to take inspiration from Busify's readme due to a similar tech stack and add a few points about the project how it helps out the community.

Thats about it do feel free to reach out and ask for help !!

@VarunGitGood VarunGitGood added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 2, 2023
@Geetika09
Copy link

please assign this issue to me

@VarunGitGood
Copy link
Collaborator Author

Sure @Geetika09 do reach out for help

@RISHIKESHk07
Copy link

RISHIKESHk07 commented Jul 4, 2023

@varun7singh is their any upcoming updates? i would like to contribute .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants