Skip to content

Commit 20cfb4c

Browse files
authored
Update README.md
1 parent a7dbe94 commit 20cfb4c

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,15 @@ Works with any Java library that depends on `kafka-clients`, including:
3131
- **Intelligent optimization**: Identifies the most impactful topics to optimize
3232
- **Graceful fallback**: Falls back to default settings if optimization fails
3333

34-
## Linger Time Configuration
35-
36-
The linger.ms parameter follows these rules:
37-
38-
1. If SUPERSTREAM_LATENCY_SENSITIVE is set to true:
39-
- Linger value will never be modified, regardless of other settings
34+
## Installation
4035

36+
*Superstream package*: https://central.sonatype.com/artifact/ai.superstream/superstream-clients-java/overview
4137

42-
2. If SUPERSTREAM_LATENCY_SENSITIVE is set to false or not set:
43-
- If no explicit linger exists in original configuration: Use Superstream's optimized value
44-
- If explicit linger exists: Use the maximum of original value and Superstream's optimized value
38+
### Step 1: Add Superstream package
4539

46-
## Installation
40+
#### Maven
4741

48-
### Maven
42+
Always use the latest version
4943

5044
```xml
5145
<dependency>
@@ -55,24 +49,24 @@ The linger.ms parameter follows these rules:
5549
</dependency>
5650
```
5751

58-
### Gradle
52+
#### Gradle
53+
54+
Always use the latest version
5955

6056
```groovy
61-
implementation 'ai.superstream:superstream-clients:1.0.0'
57+
implementation group: 'ai.superstream', name: 'superstream-clients-java', version: '1.0.1-beta'
6258
```
6359

64-
## Usage
65-
66-
Step 1: Get the Superstream jar
60+
### Step 2: Run
6761

68-
Step 2:
6962
Add the Java agent to your application's startup command:
7063

7164
```bash
7265
java -javaagent:/path/to/superstream-clients-1.0.0.jar -jar your-application.jar
7366
```
7467

75-
Usually it will be
68+
Common example:
69+
7670
```bash
7771
java -javaagent:$MAVEN_REPOSITORY$/ai/superstream/superstream-clients/1.0.0/superstream-clients-java-1.0.0.jar -jar your-application.jar
7872
```
@@ -138,6 +132,17 @@ export SUPERSTREAM_TOPICS_LIST=orders,payments,user-events
138132
export SUPERSTREAM_LATENCY_SENSITIVE=true
139133
```
140134

135+
### SUPERSTREAM_LATENCY_SENSITIVE Explained
136+
137+
The linger.ms parameter follows these rules:
138+
139+
1. If SUPERSTREAM_LATENCY_SENSITIVE is set to true:
140+
- Linger value will never be modified, regardless of other settings
141+
142+
2. If SUPERSTREAM_LATENCY_SENSITIVE is set to false or not set:
143+
- If no explicit linger exists in original configuration: Use Superstream's optimized value
144+
- If explicit linger exists: Use the maximum of original value and Superstream's optimized value
145+
141146
## Prerequisites
142147

143148
- Java 11 or higher

0 commit comments

Comments
 (0)