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.

Sign up for GitHub

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

Jump to bottom

Update README #45

Open

Shrreya opened this issue Feb 21, 2022 · 0 comments · May be fixed by #48

Assignees

Collaborator

Shrreya commented Feb 21, 2022

Must-haves:

Project overview
Features list
Instructions for local development (yarn, yarn start, yarn test, husky local CI setup explained)
Technologies used (You can use badges for this)
Team members profiles (links to github profiles)
Link to hosted project (add after hosting is done)

Nice to haves:

Screenshots of your system diagrams, ERD diagram, home page

For more details, check out this article.
Here is an example README from a frontend capstone project.

halitbatur assigned Kishimoto96

Kishimoto96 linked a pull request

that will close this issue

add readme v1 #48

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment