255 - updated README (#257)

xtuml · Oct 25, 2024 · bd83c72 · bd83c72
1 parent 4570555
commit bd83c72
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -184,7 +184,7 @@ This dependency is automatically managed when using the devcontainer setup or wh
 
 ## Installation
 
-There are two ways to set up this project: manual installation or using a devcontainer (recommended).
+There are two ways to set up this project: manual installation (both for usage and development) or using a devcontainer (development).
 
 ### Manual Installation
 
@@ -274,6 +274,8 @@ Alternatively, you can use the provided devcontainer, which manages all dependen
 
 The devcontainer will automatically set up the environment with all necessary dependencies.
 
+It is recommended to only use this for development purposes as files/directories on the users system will not be reachable from the container without specifically mounting volumes.
+
 ## tel2puml CLI Documentation
 
 `tel2puml` is a command-line tool designed to convert [OpenTelemetry](https://opentelemetry.io/)  into [PlantUML](https://plantuml.com/) sequence diagrams.