Update the web integration section in README.md (#1429)

AgoraIO-Extensions · Nov 8, 2023 · 6106a43 · 6106a43
1 parent 5a6f91b
commit 6106a43
Showing 1 changed file with 20 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ Open the `Info.plist` and add:
 >
 > The `agora_rtc_engine` web is built on top of [iris_web](https://github.com/AgoraIO-Extensions/iris_web), a wrapper for the [Agora Web SDK 4.x](https://api-ref.agora.io/en/video-sdk/web/4.x/index.html). This helps align the Native SDK (Android/iOS/macOS/Windows) APIs through the [Agora Web SDK 4.x](https://api-ref.agora.io/en/video-sdk/web/4.x/index.html). Please note that the agora_rtc_engine web utilizes the [Agora Web SDK 4.x](https://api-ref.agora.io/en/video-sdk/web/4.x/index.html) underneath, so only a subset of the Native SDK APIs can be implemented on the web. If the APIs return `AgoraRtcException` with a `-4` error code, this means these APIs are not supported at this time.
 
-We recommend downloading the `iris_web` artifact and including it as a local script in your `<your-project>/web/index.html` file, as this will allow for fine-grained control over how you host it. For example:
+Download the `iris_web`(see the link below) artifact and include it as a `<script />` tag in your `<your-project>/web/index.html` file. For example:
 
 **Project structure**
 ```
@@ -80,16 +80,33 @@ We recommend downloading the `iris_web` artifact and including it as a local scr
    |__index.html
    |__iris-web-rtc_<x.y.z>.js
 ```
+
 ```html
-<script src="iris-web-rtc_<x.y.z>.js"></script>
+<!-- <your-project>/web/index.html -->
+<!DOCTYPE html>
+<html>
+...
+<body>
+  ...
+  <script src="iris-web-rtc_<x.y.z>.js"></script>
+</body>
+</html>
 ```
 Download: https://download.agora.io/staging/iris-web-rtc_n423_w4182_0.3.0.js
 
 **For Testing Purposes**
 
 You can directly depend on the Agora CDN for testing purposes:
 ```html
-<script src="https://download.agora.io/staging/iris-web-rtc_n423_w4182_0.3.0.js"></script>
+<!-- <your-project>/web/index.html -->
+<!DOCTYPE html>
+<html>
+...
+<body>
+  ...
+  <script src="https://download.agora.io/staging/iris-web-rtc_n423_w4182_0.3.0.js"></script>
+</body>
+</html>
 ```
 
 ## API Reference Resources