commit d1f849396fcff9fed17e77ed7eba506a426f52d3
author Abdullah YILDIZ <abdullahyildiz@users.noreply.github.com> Tue Dec 28 13:10:24 2021 +0300
committer GitHub <noreply@github.com> Tue Dec 28 13:10:24 2021 +0300
tree d0b9d4f0964b83d14f67eb69cac1ad54dc1f0d5a
parent 233329ba5706f232acba5b9f55e580a0664743b9

Update README.md

README.md

diff --git a/README.md b/README.md
index 3706438..5b2fc29 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,37 @@
-# Caravel User Project
+# YONGA-Turbo Encoder
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![UPRJ_CI](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [![Caravel Build](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml)
 
-| :exclamation: Important Note            |
-|-----------------------------------------|
+Table of contents
+=================
 
-## Please fill in your project documentation in this README.md file 
+- [Overview](#overview)
+- [Setup](#setup)
+- [Running Simulation](#running-simulation)
+- [Hardening the User Project Macro using OpenLANE](#hardening-the-user-project-macro-using-openlane)
+- [List of Contributors](#list-of-contributors)
 
+Overview
+========
 
-Refer to [README](docs/source/index.rst) for this sample project documentation. 
+TBA
+
+Setup
+========
+
+TBA
+
+Running Simulation
+========
+
+TBA
+
+Hardening the User Project Macro using OpenLANE
+========
+
+TBA
+
+List of Contributors
+=================================
+
+TBA