Merge pull request #15 from ayeshLK/master

Update package documentation
ballerina-platform · Apr 15, 2024 · db5b2f5 · db5b2f5
2 parents b5cfef7 + 6c4a80a
commit db5b2f5
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 The `ballerinax/guidewire.insnow` package provides a client API to connect to Guidewire InsuranceNow cloud API using Ballerina.
 
-The Ballerina Guidewire InsuranceNow connector is compatible with the Guidewire InsuranceNow `2023.3 (Innsbruck)` REST API version.
+The Ballerina Guidewire InsuranceNow connector is compatible with the Guidewire InsuranceNow [`2023.3 (Innsbruck)`](https://docs.guidewire.com/cloud/in/20233/apiref/) REST API version.
 
 ## Setup guide
 
@@ -104,7 +104,7 @@ bal run
 
 ## Examples
 
-The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/master/examples/), covering the following use cases:
+The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/), covering the following use cases:
 
 1. [Online application portal](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/online-application-portal) - Implement an online insurance application portal using Guidewire InsuranceNow cloud API.
 

diff --git a/ballerina/Module.md b/ballerina/Module.md
@@ -4,7 +4,7 @@
 
 The `ballerinax/guidewire.insnow` package provides a client API to connect to Guidewire InsuranceNow cloud API using Ballerina.
 
-The Ballerina Guidewire InsuranceNow connector is compatible with the Guidewire InsuranceNow `2023.3 (Innsbruck)` REST API version.
+The Ballerina Guidewire InsuranceNow connector is compatible with the Guidewire InsuranceNow [`2023.3 (Innsbruck)`](https://docs.guidewire.com/cloud/in/20233/apiref/) REST API version.
 
 ## Setup guide
 
@@ -98,6 +98,6 @@ bal run
 
 ## Examples
 
-The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/master/examples/), covering the following use cases:
+The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/), covering the following use cases:
 
 1. [Online application portal](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/online-application-portal) - Implement an online insurance application portal using Guidewire InsuranceNow cloud API.
diff --git a/ballerina/Package.md b/ballerina/Package.md
@@ -4,7 +4,7 @@
 
 The `ballerinax/guidewire.insnow` package provides a client API to connect to Guidewire InsuranceNow cloud API using Ballerina.
 
-The Ballerina Guidewire InsuranceNow connector is compatible with Guidewire InsuranceNow `2023.3 (Innsbruck)` version.
+The Ballerina Guidewire InsuranceNow connector is compatible with the Guidewire InsuranceNow [`2023.3 (Innsbruck)`](https://docs.guidewire.com/cloud/in/20233/apiref/) REST API version.
 
 ## Setup guide
 
@@ -99,6 +99,6 @@ bal run
 
 ## Examples
 
-The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/master/examples/), covering the following use cases:
+The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/), covering the following use cases:
 
 1. [Online application portal](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/online-application-portal) - Implement an online insurance application portal using Guidewire InsuranceNow cloud API.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,33 @@
+# Examples
+
+The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/), covering the following use cases:
+
+1. [Online application portal](https://github.com/ballerina-platform/module-ballerinax-guidewire.insnow/tree/main/examples/online-application-portal) - Implement an online insurance application portal using Guidewire InsuranceNow cloud API.
+
+## Prerequisites
+
+1. Refer to the [Setup guide](https://central.ballerina.io/ballerinax/guidewire.insnow/latest#setup-guide) to set up your Guidewire InsuranceNow account, if you do not have one.
+
+2. For each example, Update your Guidewire InsuranceNow account-related configurations in the `Config.toml` file in the example root directory. Here's an example of how your `Config.toml` file should look:
+
+    ```toml
+    guidewireDomain = "<domain>"
+    username = "<username>"
+    password = "<password>"
+    ```
+
+## Running an Example
+
+Execute the following commands to build an example from the source:
+
+* To build an example:
+
+    ```bash
+    bal build
+    ```
+
+* To run an example:
+
+    ```bash
+    bal run
+    ```