Name of your project/repository

Write short and simple description of your repository/project here.

You can also add link to your website/project if available.

Check the live site/project here "your link"

Table of Contents

• Demonstration
• Brief
• Features
• Tech Stack
• APIs used
• External Libraries used
• Frameworks used
• Instructions for using this code
• To-Do list
• Found a bug?
• Contributing
• FAQ
• LICENSE
• Contact

Demonstration

Add an image or gif

Brief

Write a brief description of your repository/project.

Describe the features/how to use this/what can it do/why it is made/upcoming features/encountering errors/etc.

Features

• Light/dark mode toggle
• Live previews
• Fullscreen mode
• Cross platform

Tech-Stack

Write the langusges you used.

E.g.

1. HTML5
2. CSS3
3. JavaScript

or without numbers

• Python
• Java
• C++

APIs used

Add any APIs you used (if any). Otherwise remove this (also from table of contents)

Example:

Google Maps Embed API - The Maps Embed API lets you place an interactive map on your web page.

External Libraries used

Add any external libraries you used (if any). Otherwise remove this (also from table of contents)

Example:

jQuery - jQuery is a JavaScript library. jQuery takes a lot of common tasks that require many lines of JavaScript code to accomplish, and wraps them into methods that you can call with a single line of code.

Frameworks used

Add any frameworks you used (if any). Otherwise remove this (also from table of contents).

Example:

Bootstrap 4 - Bootstrap is a free and open source front end development framework for the creation of websites and web apps. The Bootstrap framework is built on HTML, CSS, and JavaScript (JS) to facilitate the development of responsive, mobile-first sites and apps.

Instructions for using this code

Type the instructions/code to set up development environment for people who are going to contribute or use your repository/project.
(Remove this, also from table of contents if not needed for your repo)

E.g. Installing dependencies, paste API key, typing/replacing code, etc.

Here are some examples:

const api_key = "your api key";

git clone https://github.com/AyushShahh/github-readme-template.git

  npm install

  npm run start

To-Do list

• Things that you planned/working on
• Add as many as you want
• Things that are done (update as you complete tasks)

Found a bug?

If you find a bug, you can always open an issue in the issues tab to talk about it.
If you know a fix, you can open a pull request to contribute.

Contributing

Pull requests are always welcome. But before making any major changes you can open an issue to discuss.
For less major or minor changes, you can open a pull request.

FAQ

Question 1

Answer 1

Question 2

Answer 2

LICENSE 🛡️

This project is licensed under the {license name} License - see the LICENSE file for details.
(Remove this, also from table of contents if repo has no license)

Contact

Remove icons that you don't want

                 

Back to top