commit 9fdf8d22dcfc40611acb7210c360f11ab7e11cf3
author Mohamed Kassem <mkkassem@users.noreply.github.com> Thu Apr 29 13:57:27 2021 -0700
committer GitHub <noreply@github.com> Thu Apr 29 13:57:27 2021 -0700
tree 8580f132b178b20032d7ba4aedb968a302876bcc
parent 0218c0f3bdec6ab0e122d43aacde014fa9edb68b

Update README.md

Added formatting to highlight the importance of proper documentation

README.md

diff --git a/README.md b/README.md
index b25eab7..3706438 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,10 @@
 
 [![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)
 
----
-**NOTE**
+| :exclamation: Important Note            |
+|-----------------------------------------|
 
-Fill this README with your caravel user project documentation. 
+## Please fill in your project documentation in this README.md file 
 
----
 
 Refer to [README](docs/source/index.rst) for this sample project documentation.