chore: adding better infos in Readme about the docs

chore: adding better infos in Readme about the docs

Author: florianow

README.md

@@ -19,6 +19,24 @@ To run this module, you need the following:
   2. Privileged Role Administrator AND (Cloud) Application Administrator
 - Permissions on Azure Resource Level: User Access Administrator on the Management Group that should be managed by meshStack
 
+## Documentation
+
+This module automatically generates comprehensive documentation about your deployment. After running `terraform apply`, you can view detailed information about your configuration:
+
+```bash
+# View documentation in terminal
+terraform output -json meshplatform | jq -r '.documentation'
+
+# Save documentation to markdown file
+terraform output -json meshplatform | jq -r '.documentation' > meshplatform-docs.md
+```
+
+The documentation includes:
+- Service principal deployment status and IDs
+- Configuration details and scopes
+- meshStack integration information
+- Available terraform commands for your specific setup
+
 ## How to Use This Module
 
 ### Using Azure Portal
@@ -58,6 +76,7 @@ To run this module, you need the following:
     ```sh
     # The JSON output contains sensitive values that must not be transmitted anywhere other then the platform config screen in meshStack.
     terraform output -json
+    terraform output -json meshplatform
     ```
 
 ### Using CLI
@@ -273,6 +292,7 @@ Before opening a Pull Request, please do the following:
 | Name | Description |
 |------|-------------|
 | <a name="output_azure_ad_tenant_id"></a> [azure\_ad\_tenant\_id](#output\_azure\_ad\_tenant\_id) | The Azure AD tenant id. |
+| <a name="output_documentation"></a> [documentation](#output\_documentation) | Complete module documentation in markdown format |
 | <a name="output_mca_service_billing_scope"></a> [mca\_service\_billing\_scope](#output\_mca\_service\_billing\_scope) | n/a |
 | <a name="output_mca_service_principal"></a> [mca\_service\_principal](#output\_mca\_service\_principal) | MCA Service Principal. |
 | <a name="output_mca_service_principal_password"></a> [mca\_service\_principal\_password](#output\_mca\_service\_principal\_password) | Password for MCA Service Principal. |