Update README.md

Added formatting to highlight the importance of proper documentation
scarv · Apr 29, 2021 · 9fdf8d2 · 9fdf8d2
1 parent 0218c0f
commit 9fdf8d2
Showing 1 changed file with 3 additions and 4 deletions.
diff --git 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.