update Version1.2.4

Author: C-WangPengHui

README.md

@@ -1,40 +1,48 @@
-## compdfkit-pdf-api-java
+## ComPDFKit API in Java
+
+[ComPDFKit](https://api.compdf.com/api/docs/introduction) API provides a variety of Java API tools that allow you to create an efficient document processing workflow in a single API call. Try our various APIs for free — no credit card required.
+
 
-This is the compdfkit-pdf-api Java SDK  for the [ComPDFKit](https://api.compdf.com/api/docs/introduction) API.
 
 ## Requirements
 
-JAVA JDK 1.8 and later.
+Programming Environment: Java JDK 1.8 and higher.
+
+Dependencies: Maven.
+
 
-Maven.
 
 ## Installation
 
-Add the following dependency to your pom.xml:
+Add the following dependency to your ***"pom.xml"***:
 
 ```
 <dependency>
     <groupId>com.compdf</groupId>
-    <artifactId>compdfkit-pdf-api-java</artifactId>
-    <version>0.0.5</version>
+    <artifactId>compdfkit-api-java</artifactId>
+    <version>1.2.4</version>
 </dependency>
 ```
 
+
+
 ## Create API Client
 
-You can use your **publicKey** and **secretKey** to complete the authentication
+You can use your **publicKey** and **secretKey** to complete the authentication. You need to [sign in](https://api.compdf.com/login) your ComPDFKit API account to get your **publicKey** and **secretKey** at the [dashboard](https://api-dashboard.compdf.com/api/keys). If you are new to ComPDFKit, click here to [sign up](https://api.compdf.com/signup) for a free trial.
 
-Project public Key : You can find the public key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
+- Project public Key : You can find the public key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
 
-Project secret Key : You can find the secret Key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
+- Project secret Key : You can find the secret Key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
 
 ```java
 CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);
 ```
 
+
+
 ## Create Task
 
-A task ID is automatically generated for you based on the type of PDF tool you choose. You can provide the callback notification URL. After the task processing is completed, we will notify you of the task result through the callback interface. You can perform other operations according to the task result, such as downloading the result file.
+A task ID is automatically generated for you based on the type of PDF tool you choose. You can provide the callback notification URL. After the task processing is completed, we will notify you of the task result through the callback interface. You can perform other operations according to the request result, such as checking the status of the task, uploading files, starting the task, or downloading the result file.
 
 ```java
 // Create a client
@@ -46,20 +54,14 @@ CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.g
 
 // Get a task id
 String taskId = result.getTaskId();
+```
 
-// Upload files
-client.uploadFile(<convertFile>, taskId);
 
-// execute Task
-client.executeTask(taskId);
-```
 
 ## Upload Files
 
 Upload the original file and bind the file to the task ID. The field parameter is used to pass the JSON string to set the processing parameters for the file. Each file will generate automatically a unique filekey. Please note that a maximum of five files can be uploaded for a task ID and no files can be uploaded for that task after it has started.
 
-
-
 ```java
 // Create a client
 CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);
@@ -73,16 +75,13 @@ String taskId = result.getTaskId();
 
 // Upload files
 client.uploadFile(<convertFile>, taskId);
-
-// execute Task
-client.executeTask(taskId);
 ```
 
 
 
 ## Execute the task
 
-After the file upload is completed, call this interface with the task ID to process file.
+After the file upload is completed, call this interface with the task ID to process the files.
 
 ```java
 // Create a client
@@ -102,9 +101,11 @@ client.uploadFile(<convertFile>, taskId);
 client.executeTask(taskId);
 ```
 
-## Get TaskInfo
 
-Request task status and file-related metadata based on the task ID.
+
+## Get Task Info
+
+Request task status and file-related meta data based on the task ID.
 
 ```java
 // Create a client
@@ -120,13 +121,21 @@ String taskId = result.getTaskId();
 // Upload files
 client.uploadFile(<convertFile>, taskId);
 
-// execute Task
+// Execute Task
 client.executeTask(taskId);
 
-// query TaskInfo
+// Query TaskInfo
 CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);
 ```
 
+
+
+## Samples
+
+See ***"Samples"*** folder in this folder.
+
+
+
 ## Resources
 
 * [ComPDFKit API Documentation](https://api.compdf.com/api/docs/introduction)

pom.xml

@@ -43,7 +43,7 @@
 
     <groupId>com.compdf</groupId>
     <artifactId>compdfkit-api-java</artifactId>
-    <version>0.0.7</version>
+    <version>1.2.4</version>
 
     <name>compdfkit-api-java</name>
     <description>compdfkit-api-java</description>

samples/pom.xml

@@ -15,8 +15,8 @@
     <dependencies>
         <dependency>
             <groupId>com.compdf</groupId>
-            <artifactId>compdfkit-pdf-api-java</artifactId>
-            <version>0.0.5</version>
+            <artifactId>compdfkit-api-java</artifactId>
+            <version>1.2.4</version>
         </dependency>
     </dependencies>