Merge pull request #190 from artem-barysh-dev/updated-readme

Updated README file

README.md

@@ -14,10 +14,10 @@ The structure is as follows:
 
 ```
 └── VENDORS
-    └── Milesight
+    └── VendorName
         ├── info.json
         ├── logo.svg
-        └── WT201
+        └── DeviceName
             ├── info.json
             ├── photo.png
             └── ChirpStack
@@ -38,32 +38,32 @@ Here is a breakdown of the structure:
 
 - **VENDORS** - Root-level folder containing all vendors.
 
-  - **Milesight** - Name of the vendor.
+  - **VendorName** - Name of the vendor.
 
     - `info.json` - Describes the vendor using the following structure:
 
       ```json
       {
-        "url": "https://www.milesight.com/",
-        "description": "Milesight offers a range of sensing products to capture valuable data for diverse applications. It applies emerging technologies such as AI, 5G, and IoT to various scenarios. By responding quickly to customer challenges, Milesight collaborates with partners to deliver data-driven solutions for smart buildings, traffic management, security, cities, and more."
+        "url": "https://www.vendorwebsite.com/",
+        "description": "VendorName offers a range of sensing products to capture valuable data for diverse applications. It applies emerging technologies such as AI, 5G, and IoT to various scenarios. By responding quickly to customer challenges, VendorName collaborates with partners to deliver data-driven solutions for smart buildings, traffic management, security, cities, and more."
       }
       ```
 
     - `logo.svg` - A scalable image containing the vendor’s logo.
 
-- **WT201** - Device model.
+- **DeviceName** - Device model.
 
   - `info.json` - Describes the device using the following structure:
 
     ```json
     {
-      "url": "https://www.milesight.com/product/wt201/",
-      "label": "WT201: Smart Thermostat. Heat, EM (Emergency) Heat, Cool, Auto",
-      "description": "The WT201 is a smart occupancy sensor that detects indoor movement and monitors various environmental factors."
+      "url": "https://www.vendorwebsite.com/product/device-name/",
+      "label": "DeviceName: Smart Thermostat. Heat, EM (Emergency) Heat, Cool, Auto",
+      "description": "The DeviceName is a smart occupancy sensor that detects indoor movement and monitors various environmental factors."
     }
     ```
 
-  - `photo.png` - Photo of the device (optional).
+  - `photo.png` - Photo of the device.
 
 - **ChirpStack** - The integration type used to connect the device. Multiple integration types may be supported for the same device model. Supported integration types include:
 
@@ -72,7 +72,7 @@ Here is a breakdown of the structure:
   - **uplink** - Subfolder for uplink data converters:
 
     - `converter.json` - The converter entity exported as JSON from the platform. Both TBEL and JS converters are supported.
-    - `metadata.json` - Represents a map of metadata keys and values (optional).
+    - `metadata.json` - Represents a map of metadata keys and values.
     - `payload.json` - An example of an incoming payload for the device and integration type. This payload will automatically load into the debug window when the converter is imported from the library. You may also use `payload.txt` or `payload.base64` for text or binary payload representation.
     - `result.json` - Expected result from the converter based on the provided payload and metadata, used to validate that the converter works correctly.
     - `payload_XX.json`, `result_XX.json` - Additional payload files for automated tests.
@@ -95,7 +95,7 @@ If your validation fails (**the workflow is marked with a red cross**) click on
 
 For example, you may encounter a message like this:
 
-`Validation failed for VENDORS/Milesight/AM307/ChirpStack/uplink with payload payload.json and result result.json. Expected output does not match.`
+`Validation failed for VENDORS/VendorName/DeviceName/ChirpStack/uplink with payload payload.json and result result.json. Expected output does not match.`
 
 This error indicates that the result.json file does not match the actual output generated by the converter when processing the provided payload.json.