Skip to content

Commit 9653816

Browse files
oschwaldclaude
andcommitted
Improve README documentation and formatting
- Add groovy syntax highlighting to Gradle code block - Document that WebServiceClient is thread-safe and should be reused - Fix trailing whitespace and punctuation - Improve sentence structure for API method descriptions Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 7d16344 commit 9653816

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To do this, add the dependency to your pom.xml:
2424

2525
Add the following to your `build.gradle` file:
2626

27-
```
27+
```groovy
2828
repositories {
2929
mavenCentral()
3030
}
@@ -47,8 +47,11 @@ takes your MaxMind account ID and license key as arguments. For example:
4747
WebServiceClient client = new WebServiceClient.Builder(6, "ABCD567890").build();
4848
```
4949

50-
If you would like to use the Sandbox environment, you can use the `host` method
51-
that belongs to the Builder. For example,
50+
The `WebServiceClient` object is thread-safe and can be reused across requests.
51+
Reusing the object allows connection pooling and improves performance.
52+
53+
If you would like to use the Sandbox environment, you can use the `host` method
54+
that belongs to the Builder. For example:
5255

5356
```java
5457
WebServiceClient client = new WebServiceClient.Builder(6, "ABCD567890")
@@ -78,13 +81,13 @@ After creating the transaction object, send a Score request by calling the
7881
ScoreResponse score = client.score(transaction);
7982
```
8083

81-
an Insights request by calling the `insights` method:
84+
Send an Insights request by calling the `insights` method:
8285

8386
```java
8487
InsightsResponse insights = client.insights(transaction);
8588
```
8689

87-
a Factors request by calling the `factors` method:
90+
Send a Factors request by calling the `factors` method:
8891

8992
```java
9093
FactorsResponse factors = client.factors(transaction);

0 commit comments

Comments
 (0)