Skip to content

Commit 8393be9

Browse files
authored
Update README.md - slight adjustments to make it more readable.
1 parent ca4aa47 commit 8393be9

File tree

1 file changed

+37
-38
lines changed

1 file changed

+37
-38
lines changed

README.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
# The WooCommerce REST API Client for Java
1+
# The WooCommerce REST API Client for Java
22

3-
The WooCommerce REST API client library for Java provides easy access to the features of the e-commerce platform's API.
4-
The client supports the WooCommerce REST API in the latest v3 version.
3+
Effortlessly integrate your Java applications with WooCommerce using our REST API client! 🚀
4+
This library provides an intuitive and developer-friendly way to interact with the latest **WooCommerce REST API (v3)**, allowing seamless access to store data and operations.
55

66
---
77

8-
> ⚠️ **Note: This is a development version!**
9-
>
10-
> The API client is under development and will be gradually expanded to cover the key API functionalities of the commerce engine.
8+
> ⚠️ **Note: This is an early development version!**
9+
> We are actively expanding the API coverage to support more WooCommerce features.
10+
> Contributions and feedback are welcome!
1111
1212
---
1313

14+
## 🚀 Quick Start
1415

15-
## Setup
16-
1. Download this project and build it to create a new artifact in the local Maven repository using the following command:
17-
```
16+
### 1️⃣ Install
17+
Clone this repository and build the library using Maven:
18+
19+
```sh
1820
mvn clean install
19-
```
20-
2. After a successful build, you can use the newly created `woocommerce-api-client` artifact as a dependency in your Java project.:
21+
```
22+
23+
After a successful build, you can add the generated artifact as a dependency in your Java project:
24+
2125
```xml
2226
<dependency>
2327
<groupId>wtx.woocommerce</groupId>
@@ -26,53 +30,48 @@ mvn clean install
2630
</dependency>
2731
```
2832

29-
## Usage
30-
Below is an example usage of the WooCommerceApiClient:
33+
### 2️⃣ Usage Example
3134

32-
```java
33-
package wtx.woocommerce;
35+
Easily fetch WooCommerce customer data:
3436

37+
```java
3538
import java.util.List;
36-
37-
import wtx.woocommerce.api.client.CustomersApi;
39+
import wtx.woocommerce.api.client.*;
3840
import wtx.woocommerce.api.client.invoker.ApiException;
3941
import wtx.woocommerce.api.client.model.Customer;
4042

41-
public class WooCommerceApiClientUsageDemo {
43+
public class WooCommerceClientDemo {
4244

4345
public static void main(String[] args) {
4446

45-
System.out.println(">>> Start running the WooCommerceApiClientUsageDemo...");
47+
System.out.println(">>> Starting WooCommerceClientDemo...");
4648

47-
// Use WooCommerceApiClient(true) if you need to log API communication messages.
4849
WooCommerceApiClient apiClient = new WooCommerceApiClient();
49-
50-
// TODO: Set your host and credentials!
5150
apiClient.setBasePath("https://your-woocommerce-shop.com/wp-json/wc/v3");
52-
apiClient.setUsername("TODO_SET_API_USERNAME");
53-
apiClient.setPassword("TODO_SET_API_PASSWORD");
51+
apiClient.setUsername("YOUR_API_USERNAME");
52+
apiClient.setPassword("YOUR_API_PASSWORD");
5453

5554
CustomersApi customersApi = new CustomersApi(apiClient);
5655

5756
try {
58-
5957
List<Customer> customers = customersApi.listAllCustomers(null, null, null, null, null, null, null, null, null, null, null);
60-
61-
// Example list of customer emails:
62-
for (Customer customer : customers) {
63-
System.out.println("Customer: " + customer.getEmail());
64-
}
65-
58+
customers.forEach(customer -> System.out.println("Customer: " + customer.getEmail()));
6659
} catch (ApiException e) {
67-
System.err.println("Error occurred during API call: " + e);
60+
System.err.println("API Error: " + e.getMessage());
6861
}
6962

70-
System.out.println("<<< The WooCommerceApiClientUsageDemo has been finished.");
71-
63+
System.out.println("<<< WooCommerceClientDemo finished.");
7264
}
73-
7465
}
7566
```
76-
## Stay Connected!
77-
The WooCommerce API client library is evolving with exciting new features and improvements on the way.
78-
We can't wait to share more with you - stay tuned! 😊
67+
68+
---
69+
70+
## 🔗 Stay Connected
71+
72+
✨ We’re constantly improving this client with new features!
73+
💡 Have suggestions or need help? Open an [issue](https://github.com/YOUR_REPO/issues) or contribute!
74+
75+
🚀 Happy coding! 😊
76+
77+
**Your WTX Labs Team 🚀**

0 commit comments

Comments
 (0)