docs: improve docs

vaened · Aug 23, 2024 · 07e9483 · 07e9483
1 parent a5e72d8
commit 07e9483
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/.github/images/autocomplete-route-name.gif b/.github/images/autocomplete-route-name.gif
diff --git a/readme.md b/readme.md
@@ -8,7 +8,7 @@ modular routing, allowing you to separate routes based on URL patterns into diff
 making it easier to manage and scale your application’s routing structure.
 
 <a href="#">
-    <img src="./.github/images/routes-example.jpg" alt="routes-example"/>
+    <img src=".github/images/routes-example.jpg" alt="routes-example"/>
 </a>
 
 ## Installation
@@ -59,6 +59,13 @@ const data = response.json();
 console.log(data)
 ```
 
+Additionally, you can export the routes as a TypeScript file to enable route autocompletion in your editor. To achieve this, simply modify
+the `output` option in the configuration file.
+
+<a href="#" s>  
+    <img src=".github/images/autocomplete-route-name.gif" alt="routes-example"/>  
+</a>
+
 ### Service
 
 The route service provides three key methods to interact with the generated routes: