Merge pull request #42 from ayeshLK/docs

Fix review suggestions

README.md

@@ -10,14 +10,7 @@ communication between disparate systems and applications. IBM MQ ensures the sec
 asynchronously, decoupling senders and receivers for efficient and scalable communication. It supports both
 point-to-point and publish/subscribe messaging models via queues and topics.
 
-The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina.
-
-## Compatibility
-
-|                        |   Version    |
-|:-----------------------|:------------:|
-| IBM MQ Server          | **9.3 or earlier** |
-| IBM MQ Client Connector|  **9.3.4.0**  |
+The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. The current connector is compatible with IBM MQ server versions up to 9.3.
 
 ## Setup guide
 
@@ -27,31 +20,33 @@ Alternatively, to use IBM MQ on the cloud, [sign up](https://cloud.ibm.com/regis
 
 ### Create a queue
 
-1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to
-   [https://localhost:9443/ibmmq/console](https://localhost:9443/ibmmq/console) URL in your browser to access the IBM MQ console.
+1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to `https://<host>:<port>/ibmmq/console` URL in your browser to access the IBM MQ console.
+
 2. Click on the `Create a queue` link.
 
-![Create a queue](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png alt="Create a queue" style="width: 70%;">
 
 3. Select the queue type.
 
-![Select the queue type](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png alt="Select the queue type" style="width: 70%;">
+
+### Create a topic
 
-4. Go back to the home page and click on the `Manage` link on the sidebar.
+1. Go back to the home page and click on the `Manage` link on the sidebar.
 
-![Click on Manage](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png alt="Click on manage" style="width: 70%;">
 
-5. Navigate to `Events` tab.
+2. Navigate to `Events` tab.
 
-![Navigate to Events tab](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png alt="Navigate to events tab" style="width: 70%;">
 
-6. Click on `Create`.
+3. Click on `Create`.
 
-![Click on create](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png alt="Click on create" style="width: 70%;">
 
 ## Quickstart
 
-To use the IBM MQ connector in your Ballerina application, modify the .bal file as follows:
+To use the IBM MQ connector in your Ballerina application, modify the `.bal` file as follows:
 
 ### Step 1: Import the connector
 

ballerina/Ballerina.toml

@@ -1,9 +1,9 @@
 [package]
 org = "ballerinax"
 name = "ibm.ibmmq"
-version = "0.1.4"
+version = "1.0.0"
 authors = ["Ballerina"]
-keywords = ["ibm-mq"]
+keywords = ["ibm.ibmmq", "client", "messaging", "network", "pubsub"]
 repository = "https://github.com/ballerina-platform/module-ballerinax-ibm.ibmmq"
 icon = "icon.png"
 license = ["Apache-2.0"]
@@ -12,8 +12,8 @@ distribution = "2201.8.0"
 [[platform.java17.dependency]]
 groupId = "io.ballerina.stdlib"
 artifactId = "ibm.ibmmq-native"
-version = "0.1.4"
-path = "../native/build/libs/ibm.ibmmq-native-0.1.4-SNAPSHOT.jar"
+version = "1.0.0"
+path = "../native/build/libs/ibm.ibmmq-native-1.0.0-SNAPSHOT.jar"
 
 [[platform.java17.dependency]]
 groupId = "org.json"

ballerina/Dependencies.toml

@@ -63,7 +63,7 @@ modules = [
 [[package]]
 org = "ballerinax"
 name = "ibm.ibmmq"
-version = "0.1.4"
+version = "1.0.0"
 dependencies = [
 	{org = "ballerina", name = "crypto"},
 	{org = "ballerina", name = "jballerina.java"},

ballerina/Module.md

@@ -5,14 +5,7 @@ communication between disparate systems and applications. IBM MQ ensures the sec
 asynchronously, decoupling senders and receivers for efficient and scalable communication. It supports both 
 point-to-point and publish/subscribe messaging models via queues and topics.
 
-The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina.
-
-## Compatibility
-
-|                        |   Version    |
-|:-----------------------|:------------:|
-| IBM MQ Server          | **9.3 or earlier** |
-| IBM MQ Client Connector|  **9.3.4.0**  |
+The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. The current connector is compatible with IBM MQ server versions up to 9.3.
 
 ## Setup guide
 
@@ -22,31 +15,33 @@ Alternatively, to use IBM MQ on the cloud, [sign up](https://cloud.ibm.com/regis
 
 ### Create a queue
 
-1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to 
-[https://localhost:9443/ibmmq/console](https://localhost:9443/ibmmq/console) URL in your browser to access the IBM MQ console. 
+1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to `https://<host>:<port>/ibmmq/console` URL in your browser to access the IBM MQ console.
+
 2. Click on the `Create a queue` link.
 
-![Create a queue](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png alt="Create a queue" style="width: 70%;">
 
 3. Select the queue type.
 
-![Select the queue type](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png alt="Select the queue type" style="width: 70%;">
+
+### Create a topic
 
-4. Go back to the home page and click on the `Manage` link on the sidebar.
+1. Go back to the home page and click on the `Manage` link on the sidebar.
 
-![Click on Manage](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png alt="Click on manage" style="width: 70%;">
 
-5. Navigate to `Events` tab.
+2. Navigate to `Events` tab.
 
-![Navigate to Events tab](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png alt="Navigate to events tab" style="width: 70%;">
 
-6. Click on `Create`.
+3. Click on `Create`.
 
-![Click on create](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png alt="Click on create" style="width: 70%;">
 
 ## Quickstart
 
-To use the IBM MQ connector in your Ballerina application, modify the .bal file as follows:
+To use the IBM MQ connector in your Ballerina application, modify the `.bal` file as follows:
 
 ### Step 1: Import the connector
 

ballerina/Package.md

@@ -5,14 +5,7 @@ communication between disparate systems and applications. IBM MQ ensures the sec
 asynchronously, decoupling senders and receivers for efficient and scalable communication. It supports both
 point-to-point and publish/subscribe messaging models via queues and topics.
 
-The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina.
-
-## Compatibility
-
-|                        |   Version    |
-|:-----------------------|:------------:|
-| IBM MQ Server          | **9.3 or earlier** |
-| IBM MQ Client Connector|  **9.3.4.0**  |
+The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. The current connector is compatible with IBM MQ server versions up to 9.3.
 
 ## Setup guide
 
@@ -22,31 +15,33 @@ Alternatively, to use IBM MQ on the cloud, [sign up](https://cloud.ibm.com/regis
 
 ### Create a queue
 
-1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to
-   [https://localhost:9443/ibmmq/console](https://localhost:9443/ibmmq/console) URL in your browser to access the IBM MQ console.
+1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to `https://<host>:<port>/ibmmq/console` URL in your browser to access the IBM MQ console.
+
 2. Click on the `Create a queue` link.
 
-![Create a queue](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png alt="Create a queue" style="width: 70%;">
 
 3. Select the queue type.
 
-![Select the queue type](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png alt="Select the queue type" style="width: 70%;">
+
+### Create a topic
 
-4. Go back to the home page and click on the `Manage` link on the sidebar.
+1. Go back to the home page and click on the `Manage` link on the sidebar.
 
-![Click on Manage](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png alt="Click on manage" style="width: 70%;">
 
-5. Navigate to `Events` tab.
+2. Navigate to `Events` tab.
 
-![Navigate to Events tab](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png alt="Navigate to events tab" style="width: 70%;">
 
-6. Click on `Create`.
+3. Click on `Create`.
 
-![Click on create](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png)
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png alt="Click on create" style="width: 70%;">
 
 ## Quickstart
 
-To use the IBM MQ connector in your Ballerina application, modify the .bal file as follows:
+To use the IBM MQ connector in your Ballerina application, modify the `.bal` file as follows:
 
 ### Step 1: Import the connector
 

build-config/resources/Ballerina.toml

@@ -3,7 +3,7 @@ org = "ballerinax"
 name = "ibm.ibmmq"
 version = "@toml.version@"
 authors = ["Ballerina"]
-keywords = ["ibm-mq"]
+keywords = ["ibm.ibmmq", "client", "messaging", "network", "pubsub"]
 repository = "https://github.com/ballerina-platform/module-ballerinax-ibm.ibmmq"
 icon = "icon.png"
 license = ["Apache-2.0"]

examples/consume-messages/Consume Messages.md

@@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory:
 ```toml
 queueManagerName = "<queue-manager-name>"
 host = "<host>"
-port = <port>
+port = "<port>"
 channel = "<ibm-mq-channel>"
 userID = "<user-ID>"
 password = "<password>"

examples/consume-mqiih-headers/Consume MQIIH Headers.md

@@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory:
 ```toml
 queueManagerName = "<queue-manager-name>"
 host = "<host>"
-port = <port>
+port = "<port>"
 channel = "<ibm-mq-channel>"
 userID = "<user-ID>"
 password = "<password>"

examples/consume-mqrfh2-headers/Consume MQRFH2 Headers.md

@@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory:
 ```toml
 queueManagerName = "<queue-manager-name>"
 host = "<host>"
-port = <port>
+port = "<port>"
 channel = "<ibm-mq-channel>"
 userID = "<user-ID>"
 password = "<password>"

examples/ibmmq-client-security/Securing IBM MQ Client.md

@@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory:
 ```toml
 queueManagerName = "<queue-manager-name>"
 host = "<host>"
-port = <port>
+port = "<port>"
 channel = "<ibm-mq-channel>"
 userID = "<user-ID>"
 password = "<password>"

examples/produce-messages/Produce Messages.md

@@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory:
 ```toml
 queueManagerName = "<queue-manager-name>"
 host = "<host>"
-port = <port>
+port = "<port>"
 channel = "<ibm-mq-channel>"
 userID = "<user-ID>"
 password = "<password>"

examples/produce-mqiih-headers/Produce MQIIH Headers.md

@@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory:
 ```toml
 queueManagerName = "<queue-manager-name>"
 host = "<host>"
-port = <port>
+port = "<port>"
 channel = "<ibm-mq-channel>"
 userID = "<user-ID>"
 password = "<password>"

examples/produce-mqrfh2-headers/Produce MQRFH2 Headers.md

@@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory:
 ```toml
 queueManagerName = "<queue-manager-name>"
 host = "<host>"
-port = <port>
+port = "<port>"
 channel = "<ibm-mq-channel>"
 userID = "<user-ID>"
 password = "<password>"

gradle.properties

@@ -1,6 +1,6 @@
 org.gradle.caching=true
 group=io.ballerina.lib
-version=0.1.4-SNAPSHOT
+version=1.0.0-SNAPSHOT
 ballerinaLangVersion=2201.8.0
 
 checkstylePluginVersion=10.12.1