The README.md
file is a powerful tool that helps you a user implement your project and gives them the jist of what your app does. The following are the minimum requirements expected on all fullstack applications.
-
A brief description of the application itself
-
What the app is for
-
What problem does it hope to solve
-
Who is the app designed for
-
-
The technologies used
-
Contributors
-
A link to the back-end repo/front-end repo, respectively
-
A link to deployed back-end site && font-end site
-
Install steps
Attaching screen shots of the working app or a gif of the application running makes it more likely a rectuirer or team lead will actually see what you have created. People care about your ability to create something that works.