Feature/document (#5)

* Initial commit

* feat: add rest client to call UPS API

* feat: add tracking demo

* Finalize demo of UPS

* update pom.xml

* add JUnit Test for ups connector

* chore: polish doc & move images to folder

* chore: Update product.json & group id, project version

* fix: Correct version

* chore: Adjust product component

* fix: update version

* fix: update version

* refactor: format code and remove unused code

* update pom.xml add oauth module

* remove line space

* refactor: change to normal property to avoid encoded the variable on rest client config

* fix: correct parameter in process after changing variable name

* refactor: add variable for Auth base URL

* refactor: use frame-10 template, update property name

* fix: update project build plugin version

* Remove pattern project

* refactor: update package name, format code

* fix: correct OAuth feature location on rest client

* refactor: add connector tags, change version in pom.xml

* refactor: add tag for demo project

* update project build plugin version (#7)

* Handle feedbacks for documentation

* Update README file

---------

Co-authored-by: Ny Huynh <129814849+ny-huynh@users.noreply.github.com>
Co-authored-by: Ny Huynh <ny.huynhthi@axonactive.com>
Co-authored-by: AAVN\ptanh2 <anh.phamthai@axonactive.com>
Co-authored-by: ptanhaxon <129739104+ptanhaxon@users.noreply.github.com>

ups-connector-product/README.md

@@ -1,74 +1,73 @@
 # UPS Modules
 
 ## Description
-This is a UPS modules made in Axon Ivy framework. It allows users to quickly and easily integrate with UPS Service. With this App, users can effortlessly manage their packages from UPS.
-With this connector:
-- Gives you full power to the OpenAPI UPS services.
-- Supports you with an easy-to-copy demo implementation to reduce your integration effort.
-
-UPS modules contains:
-- ups-connector
-- ups-oauth-feature
-- ups-connector-demo
-- ups-connector-product
-- ups-connector-test
-
-Common use cases for UPS APIs:
-- Shipping and tracking packages for your business
-- Obtaining shipping rates and time in transit for ecommerce
-- Creating visibility applications for your customers on your platform
-
-View the [API catalog](https://developer.ups.com/catalog) to identify which APIs meet your business needs.
-We hope you enjoy and we look forward to your contributions!
-
-## Set up
-
-1. Go to https://developer.ups.com, login or create a new UPS account. 
-2. Create an Application on UPS 
-3. After creating your application, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token to authorize your API requests
-4. Configure the following variables in your project: 
-![Alt text](image-11.png)
+The Axon Ivy [UPS connector](https://developer.ups.com/catalog) enables users to integrate UPS services seamlessly into any business process. This connector:
+- Empowers you with full access to the OpenAPI UPS API Catalog
+- Features everyday use cases such as tracking packages, obtain shipping rates, and validating addresses
+- Provides an easy-to-copy demo implementation to streamline your integration efforts.
 
+Explore the [API catalog](https://developer.ups.com/catalog) to identify which APIs align with your business needs.
 
+## Setup
+1. Go to https://developer.ups.com, login with your user or create a new UPS account.
+2. Create an application on UPS
+3. Once your application is created, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token for authorizing your API requests
+4. Configure the following variables in your project:
+![Alt text](images/image-11.png)
 
 ## Demo
 ### Get tracking information
-This service is used to retrieve package information
+This service is used to retrieve package information.
 1. Login to the Axon Ivy Portal
 2. On the Process List page, click on **Get Tracking**
-![Alt text](image-1.png)
+
+![Alt text](images/image-1.png)
+
 3. Fill in your tracking number
-![Alt text](image-2.png)
+
+![Alt text](images/image-2.png)
+
 4. Click **Search** button to get all information of the package
-![Alt text](image-3.png)
+
+![Alt text](images/image-3.png)
 
 ### Pickup Creation
-This service is used to schedule pickups
+This service is used to schedule pickups.
 1. Login to the Axon Ivy Portal
 2. On the Process List page, click on **Pickup Creation**
-![Alt text](image-5.png)
+
+![Alt text](images/image-5.png)
+
 3. Fill in required fields
-![Alt text](image-4.png)
-4. Click **Process** button to schedule pickups
-![Alt text](image-12.png)
 
+![Alt text](images/image-4.png)
+
+4. Click **Process** button to schedule pickups
 
+![Alt text](images/image-12.png)
 
 ### Pickup cancel
-This service is used to cancel previously scheduled pickups
+This service is used to cancel previously scheduled pickups.
 1. Login to the Axon Ivy Portal
 2. On the Process List page, click on **Pickup Creation**
-![Alt text](image-8.png)
+
+![Alt text](images/image-8.png)
+
 3. Fill in required fields
-![Alt text](image-7.png)
-4. Click **Cancel** button to finish
 
+![Alt text](images/image-7.png)
+
+4. Click **Cancel** button to finish
 
 ### Address validation
-This service is used to check addresses against the United States Postal Service database of valid addresses in the U.S
+This service is utilized to verify addresses against the United States Postal Service database of valid addresses in the U.S.
 1. Login to the Axon Ivy Portal
 2. On the Process List page, click on **Validate Address**
-![Alt text](image-9.png)
+
+![Alt text](images/image-9.png)
+
 3. Fill in address info
-![Alt text](image-10.png)
+
+![Alt text](images/image-10.png)
+
 4. Click **Validate** button