Badges
Markdown Cheatsheet for Github Readme.md. Contribute to tchapi/markdown-cheatsheet development by creating an account on GitHub. Oct 07, 2020 Markdown Cheatsheet for Github Readme.md. Contribute to tchapi/markdown-cheatsheet development by creating an account on GitHub.
Badges aren't necessary, but they look nice and also looks more professional so other developers know that you know what you're doing. If you need to find some badges a good place to look is shields.io
Screenshot / GIF of the application (Demo)
Provide a screenshot or GIF of your application. Using a GIF is generally more pleasing as people can see in real time how the application works.
Application Description
Provide a short description of your application here.
Github Readme File
Eg. Real time chat application designed to allow people to chat instantly
Table of Contents
Demo
Provide links to the deployed application for users to be able to view it easily. If you have any other links you would like to show here, feel free.
View the application at Deployed Project Link
Technology Stack
This is where you want to demonstrate the technologies you used in this project and provide any links.
| Technology | Description | Link |
|---|---|---|
| HTML5 | Hyper Text Markup Language | ---- |
| CSS3 | Cascading Style Sheets | ---- |
| JavaScript | High Level, Dynamic, Interpreted Language | ---- |
Features
If you're application has a wide range of features that you want to showcase and explain you can add them as dot points in this section. This is optional.
Installation
What are the steps required to install your project both locally and for production? Provide a step-by-step description of how to get the development environment running and also how to run this for production.
Configuration Setup
If your application requires configuration for multiple aspects such as databases or .env setup. Provide information here for each of these configuration setups. One in each smaller subheading.
Github Readme File Structure
Usage
Provide instructions and examples for use. Include screenshots if needed.
Testing
Provide instructions on how to run application tests. If the tests need to have data seeded, be sure to include information for that too.
Collaborators
If you have had people contributing to your project, a good idea is to give them credit. Create a table to add their username and a link to their GitHub account.
Any other attribution goes here as well (including third party assets or tutorials and so on)
| Username | Link |
|---|---|
| luvuong-le | github.com/luvuong-le |
Contributing
Provide instructions for other people on how to allow them to contribute to the project. These are guidelines they will have to follow if they want to contribute. The Contributor Covenant is a good place to look at industry standard guidelines for others to follow.
Note: You can have a link to a CONTRIBUTING.md file if you have a long list of guidelines to follow
License
Add information about your license that your project has.
Contact Information
You can include any contact information if you would like to such as an email address for any queries