From 4fbecaa10ddf3b5d6a79846fccfd584c75033fb7 Mon Sep 17 00:00:00 2001
From: AniruddhaKanhere <60444055+AniruddhaKanhere@users.noreply.github.com>
Date: Sun, 14 Apr 2024 21:56:00 -0700
Subject: [PATCH] Add readme to example directory

---
 examples/README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 examples/README.md

diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 000000000..2a6bc64cd
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,9 @@
+This directory contains rudementary examples of how to use the FreeRTOS-Kernel in isolation in different scenarios.
+
+1. You can find how to include proper paths and files to successfully build the kernel using CMake in [cmake_example](./cmake_example/) directory.
+2. Example on how to run Coverity Static Analysis on the kernel using CMake can be found in [coverity](./coverity) directory.
+3. Template configuration file for the kernel (FreeRTOSConfig.h) can be found in [template_configuration](./template_configuration) directory.
+
+
+You can find examples of how to use FreeRTOS-Kernel on different microcontrollers [here](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS/Demo).
+Additional examples of the kernel being used in real life applications in tandem with many other libraries (i.e. FreeRTOS+TCP, coreMQTT, coreHTTP etc.) [here](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo).