From e067103b120eb2a77fb417bb56734759b8671df5 Mon Sep 17 00:00:00 2001
From: ll7 <32880741+ll7@users.noreply.github.com>
Date: Fri, 6 Dec 2024 09:05:00 +0100
Subject: [PATCH] docs: update README.md to reflect JSON file usage and add
 warnings for SVG map parser

---
 map_editor/README.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/map_editor/README.md b/map_editor/README.md
index 0a23fd3..e703b3d 100644
--- a/map_editor/README.md
+++ b/map_editor/README.md
@@ -1,11 +1,16 @@
 # pygame based map editor from Marco
 
-This is a simple map editor from Marco who used pygame to create suitable .yaml files.
+This is a simple map editor from Marco who used pygame to create suitable .json files.
 
 Extensive documentation can be found in [docs/MAP_EDITOR_USAGE.md](../docs/MAP_EDITOR_USAGE.md)
 
 ## SVG Map Parser
 
+> [!WARNING]
+> It is recommended to use the svg map parser from `robot_sf/nav/svg_map_parser.py` instead of this one.
+
 I prefer to use `robot_sf/nav/svg_map_parser.py`.
 
 Look at `examples/svg_map_example.py` for an example of how to use it.
+
+Further documentation can be found in [docs/SVG_MAP_PARSER.md](../docs/SVG_MAP_PARSER.md).