From 569e468cd8e9e48d8043bc9c4acc148d84a12b22 Mon Sep 17 00:00:00 2001
From: Mathys Gasnier <129096726+Mathys-Gasnier@users.noreply.github.com>
Date: Sun, 29 Dec 2024 11:54:04 +0100
Subject: [PATCH] Adding a summary to the readme

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f4c34a0..aa297a9 100644
--- a/README.md
+++ b/README.md
@@ -151,6 +151,62 @@ In summary, the general order of steps is:
 
 For help starting out or to discuss clay, considering joining [the discord server.](https://discord.gg/b4FTWkxdvT)
 
+## Summary
+
+ - [High Level Documentation](#high-level-documentation)
+	- [Building UI Hierarchies](#building-ui-hierarchies)
+	- [Configuring Layout and Styling UI Elements](#configuring-layout-and-styling-ui-elements)
+	- [Element IDs](#element-ids)
+	- [Mouse, Touch and Pointer Interactions](#mouse-touch-and-pointer-interactions)
+	- [Scrolling Elements](#scrolling-elements)
+	- [Floating Elements](#floating-elements-absolute-positioning)
+	- [Custom Elements](#laying-out-your-own-custom-elements)
+	- [Retained Mode Rendering](#retained-mode-rendering)
+	- [Visibility Culling](#visibility-culling)
+	- [Preprocessor Directives](#preprocessor-directives)
+	- [Bindings](#bindings-for-non-c)
+	- [Debug Tools](#debug-tools)
+ - [API](#api)
+	- [Naming Conventions](#naming-conventions)
+	- [Public Functions](#public-functions)
+ 		- [Lifecycle](#lifecycle-for-public-functions)
+     		- [Clay_MinMemorySize](#clay_minmemorysize)
+       		- [Clay_CreateArenaWithCapacityAndMemory](#clay_createarenawithcapacityandmemory)
+         	- [Clay_SetMeasureTextFunction](#clay_setmeasuretextfunction)
+         	- [Clay_SetMaxElementCount](clay_setmaxelementcount)
+         	- [Clay_SetMaxMeasureTextCacheWordCount](#clay_setmaxmeasuretextcachewordcount)
+         	- [Clay_Initialize](#clay_initialize)
+         	- [Clay_SetLayoutDimensions](#clay_setlayoutdimensions)
+         	- [Clay_SetPointerState](#clay_setpointerstate)
+         	- [Clay_UpdateScrollContainers](#clay_updatescrollcontainers)
+         	- [Clay_BeginLayout](#clay_beginlayout)
+         	- [Clay_EndLayout](#clay_endlayout)
+         	- [Clay_Hovered](#clay_hovered)
+         	- [Clay_OnHover](#clay_onhover)
+         	- [Clay_PointerOver](#clay_pointerover)
+         	- [Clay_GetScrollContainerData](#clay_getscrollcontainerdata)
+         	- [Clay_GetElementId](#clay_getelementid)
+          - [Element Macros](#element-macros)
+         	- [CLAY](#clay-1)
+         	- [CLAY_ID](#clay_id)
+         	- [CLAY_IDI](#clay_idi)
+         	- [CLAY_LAYOUT](#clay_layout)
+         	- [CLAY_RECTANGLE](#clay_rectangle)
+         	- [CLAY_TEXT](#clay_text)
+         	- [CLAY_IMAGE](#clay_image)
+         	- [CLAY_SCROLL](#clay_scroll)
+         	- [CLAY_BORDER](#clay_border)
+         	- [CLAY_FLOATING](#clay_floating)
+         	- [CLAY_CUSTOM_ELEMENT](#clay_custom_element)
+          - [Data Structures & Defs](data-structures--definitions)
+         	- [Clay_String](#clay_string)
+         	- [Clay_ElementId](#clay_elementid)
+         	- [Clay_RenderCommandArray](#clay_rendercommandarray)
+         	- [Clay_RenderCommand](#clay_rendercommand)
+         	- [Clay_ScrollContainerData](#clay_scrollcontainerdata)
+         	- [Clay_ErrorHandler](#clay_errorhandler)
+         	- [Clay_ErrorData](#clay_errordata)
+
 ## High Level Documentation
 
 ### Building UI Hierarchies
@@ -1883,4 +1939,4 @@ A [Clay_String](#clay_string) that provides a human readable description of the
 
 A generic pointer to extra userdata that is transparently passed through from `Clay_Initialize` to Clay's error handler callback. Defaults to NULL.
 
----
\ No newline at end of file
+---