From 3a590f67ca0d0e110c9fd664c19b78d1ba136896 Mon Sep 17 00:00:00 2001
From: PorkodiVenkatesh <70228962+PorkodiVenkatesh@users.noreply.github.com>
Date: Tue, 25 Aug 2020 13:44:52 -0400
Subject: [PATCH] Update README.md

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 71d3474..db31526 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,50 @@
-# PROJECT-NAME
\ No newline at end of file
+# PROJECT-NAME
+
+>**PROJECT DESCRIPTION:**  Here goes your awesome project description!
+
+## Table of contents
+* [General info](#general-info)
+* [Screenshots](#screenshots)
+* [Technologies](#technologies)
+* [Setup](#setup)
+* [Features](#features)
+* [Status](#status)
+* [Inspiration](#inspiration)
+* [Contact](#contact)
+
+## General info
+Add more general information about project. What the purpose of the project is? Motivation?
+
+## Screenshots
+![Example screenshot](./img/screenshot.png)
+
+## Technologies
+* Tech 1 - version 1.0
+* Tech 2 - version 2.0
+* Tech 3 - version 3.0
+
+## Setup
+Describe how to install / setup your local environement / add link to demo version.
+
+## Code Examples
+Show examples of usage:
+`put-your-code-here`
+
+## Features
+List of features ready and TODOs for future development
+* Awesome feature 1
+* Awesome feature 2
+* Awesome feature 3
+
+To-do list:
+* Wow improvement to be done 1
+* Wow improvement to be done 2
+
+## Status
+Project is: _in progress_, _finished_, _no longer continue_ and why?
+
+## Inspiration
+Add here credits. Project inspired by..., based on...
+
+## Contact
+Created by [@flynerdpl](https://www.flynerd.pl/) - feel free to contact me!