From 417bd2ca7037a42e120509a5ccf728c6709ddf03 Mon Sep 17 00:00:00 2001
From: Yavor Ivanov <yavor.ivanov@sap.com>
Date: Mon, 15 Apr 2024 11:27:02 +0300
Subject: [PATCH] feat: Add section for the scripts in README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index a22e15e32..acf59634e 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,22 @@ npm install --global @ui5/linter
 npm install --save-dev @ui5/linter
 ```
 
+## Preparation
+
+The UI5 Linter requires metadata to accurately identify certain issues within the codebase. While the absence of this metadata does not hinder the linter's basic functionality, it may result in incomplete findings.
+
+The extracted and generated metadata is stored within the repository under the `/resources` folder. This metadata plays a crucial role in enhancing the accuracy of the linter's analysis.
+
+Regular updates to the metadata are necessary to ensure that the data is compatible with the corresponding UI5 type definitions.
+
+```sh
+npm run update-pseudo-modules-info -- $DOMAIN_NAME/com/sap/ui5/dist/sapui5-sdk-dist/1.120.12/sapui5-sdk-dist-1.120.12-api-jsons.zip 1.120.12
+```
+
+```sh
+npm run update-semantic-model-info -- $URL 1.120.12
+```
+
 ## Usage
 
 Run the `ui5lint` command in your project root folder