Merge pull request #39 from ayeshLK/docs

Fix documentation issues
ballerina-platform · Feb 27, 2024 · cef6059 · cef6059
2 parents a4f29b1 + e113601
commit cef6059
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -14,10 +14,10 @@ The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ serve
 
 ## Compatibility
 
-| |   Version    |
-|:---|:------------:|
-|IBM MQ Server | **9.3 or earlier** |
-|IBM MQ Client Connector* |  **9.3.4.0**  |
+|                        |   Version    |
+|:-----------------------|:------------:|
+| IBM MQ Server          | **9.3 or earlier** |
+| IBM MQ Client Connector|  **9.3.4.0**  |
 
 ## Setup guide
 
@@ -129,6 +129,12 @@ ibmmq:Message? message = check queue->get();
 ibmmq:Message? message = check topic->get();
 ```
 
+### Step 4: Run the Ballerina application
+
+```Shell
+bal run
+```
+
 ### Examples
 
 The following example shows how to use the `ibm.ibmmq` connector to produce and consume messages using an IBM MQ server.

diff --git a/ballerina/Module.md b/ballerina/Module.md
@@ -9,10 +9,10 @@ The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ serve
 
 ## Compatibility
 
-| |   Version    |
-|:---|:------------:|
-|IBM MQ Server | **9.3 or earlier** |
-|IBM MQ Client Connector* |  **9.3.4.0**  |
+|                        |   Version    |
+|:-----------------------|:------------:|
+| IBM MQ Server          | **9.3 or earlier** |
+| IBM MQ Client Connector|  **9.3.4.0**  |
 
 ## Setup guide
 
@@ -124,6 +124,12 @@ ibmmq:Message? message = check queue->get();
 ibmmq:Message? message = check topic->get();
 ```
 
+### Step 4: Run the Ballerina application
+
+```Shell
+bal run
+```
+
 ### Examples
 
 The following example shows how to use the `ibm.ibmmq` connector to produce and consume messages using an IBM MQ server.

diff --git a/ballerina/Package.md b/ballerina/Package.md
@@ -9,10 +9,10 @@ The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ serve
 
 ## Compatibility
 
-| |   Version    |
-|:---|:------------:|
-|IBM MQ Server | **9.3 or earlier** |
-|IBM MQ Client Connector* |  **9.3.4.0**  |
+|                        |   Version    |
+|:-----------------------|:------------:|
+| IBM MQ Server          | **9.3 or earlier** |
+| IBM MQ Client Connector|  **9.3.4.0**  |
 
 ## Setup guide
 
@@ -124,6 +124,12 @@ ibmmq:Message? message = check queue->get();
 ibmmq:Message? message = check topic->get();
 ```
 
+### Step 4: Run the Ballerina application
+
+```Shell
+bal run
+```
+
 ### Examples
 
 The following example shows how to use the `ibm.ibmmq` connector to produce and consume messages using an IBM MQ server.