Skip to content

Commit 46b341c

Browse files
update readme
1 parent d155fbc commit 46b341c

File tree

1 file changed

+11
-53
lines changed

1 file changed

+11
-53
lines changed

README.md

Lines changed: 11 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -126,40 +126,22 @@ The Superstream library needs to modify your producer's configuration to apply o
126126

127127
*Superstream package*: https://central.sonatype.com/artifact/ai.superstream/superstream-clients-java/overview
128128

129-
### Step 1: Add Superstream package
129+
### Step 1: Add Superstream Jar to your application
130130

131-
#### Maven
131+
#### Download from GitHub
132132

133-
Always use the latest version
133+
https://github.com/superstreamlabs/superstream-clients-java/releases
134134

135-
```xml
136-
<dependency>
137-
<groupId>ai.superstream</groupId>
138-
<artifactId>superstream-clients</artifactId>
139-
<version>1.0.0</version>
140-
</dependency>
141-
```
142-
143-
#### Gradle
135+
### Available also in Maven Central
144136

145-
Always use the latest version
146-
147-
```groovy
148-
implementation group: 'ai.superstream', name: 'superstream-clients', version: '1.0.0-beta'
149-
```
137+
https://central.sonatype.com/artifact/ai.superstream/superstream-clients
150138

151139
### Step 2: Run
152140

153141
Add the Java agent to your application's startup command:
154142

155143
```bash
156-
java -javaagent:/path/to/superstream-clients-1.0.0.jar -jar your-application.jar
157-
```
158-
159-
Common example:
160-
161-
```bash
162-
java -javaagent:$MAVEN_REPOSITORY$/ai/superstream/superstream-clients/1.0.0/superstream-clients-1.0.0.jar -jar your-application.jar
144+
java -javaagent:/path/to/superstream-clients-1.0.16.jar -jar your-application.jar
163145
```
164146

165147
### Docker Integration
@@ -169,44 +151,20 @@ When using Superstream Clients with containerized applications, include the agen
169151
```dockerfile
170152
FROM openjdk:11-jre
171153

154+
WORKDIR /app
155+
172156
# Copy your application
173-
COPY target/your-application.jar /app/your-application.jar
157+
COPY target/your-application.jar app.jar
174158

175159
# Copy the Superstream agent
176-
COPY path/to/superstream-clients-1.0.0.jar /app/lib/superstream-clients-1.0.0.jar
177-
178-
# Set environment variables
179-
ENV SUPERSTREAM_TOPICS_LIST=your-topics
160+
COPY path/to/superstream-clients-1.0.16.jar superstream-agent.jar
180161

181162
# Run with the Java agent
182-
ENTRYPOINT ["java", "-javaagent:/app/lib/superstream-clients-1.0.0.jar", "-jar", "/app/your-application.jar"]
163+
ENTRYPOINT ["java", "-javaagent:/app/superstream-agent.jar", "-jar", "/app/app.jar"]
183164
```
184165

185166
Alternatively, you can use a multi-stage build to download the agent from Maven Central:
186167

187-
```dockerfile
188-
# Build stage
189-
FROM maven:3.8-openjdk-11 AS build
190-
191-
# Get the Superstream agent
192-
RUN mvn org.apache.maven.plugins:maven-dependency-plugin:3.2.0:get \
193-
-DgroupId=ai.superstream \
194-
-DartifactId=superstream-clients \
195-
-Dversion=1.0.0
196-
197-
RUN mvn org.apache.maven.plugins:maven-dependency-plugin:3.2.0:copy \
198-
-Dartifact=ai.superstream:superstream-clients:1.0.0 \
199-
-DoutputDirectory=/tmp
200-
201-
# Final stage
202-
FROM openjdk:11-jre
203-
204-
# Copy your application
205-
COPY target/your-application.jar /app/your-application.jar
206-
207-
# Copy the agent from the build stage
208-
COPY --from=build /tmp/superstream-clients-1.0.0.jar /app/lib/superstream-clients-1.0.0.jar
209-
```
210168

211169
### Required Environment Variables
212170

0 commit comments

Comments
 (0)