From 7f2044024b818c27213f5979b43682325de29881 Mon Sep 17 00:00:00 2001
From: saurabhg772244 <saurabh@mermaidchart.com>
Date: Mon, 16 Sep 2024 12:59:33 +0530
Subject: [PATCH] Updated readme for renderOptions parameter and renamed to use
 kabab case

---
 docs/{adding_new_shape => adding-new-shape}/Readme.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
 rename docs/{adding_new_shape => adding-new-shape}/Readme.md (97%)

diff --git a/docs/adding_new_shape/Readme.md b/docs/adding-new-shape/Readme.md
similarity index 97%
rename from docs/adding_new_shape/Readme.md
rename to docs/adding-new-shape/Readme.md
index 74e0f45ba..8cfbfa663 100644
--- a/docs/adding_new_shape/Readme.md
+++ b/docs/adding-new-shape/Readme.md
@@ -101,9 +101,13 @@ To add a new shape:
 - **Example**:
 
   ```typescript
-  import { Node } from '../../types.d.ts';
+  import { Node, RenderOptions } from '../../types.d.ts';
 
-  export const myNewShape = async (parent: SVGAElement, node: Node) => {
+  export const myNewShape = async (
+    parent: SVGAElement,
+    node: Node,
+    renderOptions: RenderOptions
+  ) => {
     // Create your shape here
     const shape = parent.insert('g').attr('class', 'my-new-shape');
     // Add other elements or styles as needed