Skip to content

Commit 11348e8

Browse files
change readme files location
1 parent 11d50ca commit 11348e8

File tree

3 files changed

+60
-144
lines changed

3 files changed

+60
-144
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ implementation 'ai.superstream:superstream-clients:1.0.0'
6363

6464
## Usage
6565

66+
Step 1: Get Superstream jar
67+
68+
Step 2:
6669
Add the Java agent to your application's startup command:
6770

6871
```bash

examples/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Superstream Clients
2+
3+
This repository contains the Superstream Clients library and example applications.
4+
5+
For detailed information about the library, see the [Superstream Clients Documentation](https://github.com/superstreamlabs/superstream-clients-parent/README.md).
6+
7+
## Code Examples
8+
9+
This repository includes examples showing how to use Superstream Clients with different Kafka libraries.
10+
11+
### Running Examples
12+
13+
#### Kafka Clients Example
14+
15+
```bash
16+
cd examples/kafka-clients-example
17+
mvn clean package
18+
export SUPERSTREAM_TOPICS_LIST=example-topic
19+
java -javaagent:../../target/superstream-clients-1.0.0.jar -jar target/kafka-clients-example-1.0.0-jar-with-dependencies.jar
20+
```
21+
22+
#### Spring Kafka Example
23+
24+
```bash
25+
cd examples/spring-kafka-example
26+
mvn clean package
27+
export SUPERSTREAM_TOPICS_LIST=example-topic
28+
java -javaagent:../../target/superstream-clients-1.0.0.jar -jar target/spring-kafka-example-1.0.0.jar
29+
```
30+
31+
#### Akka Kafka Example
32+
33+
```bash
34+
cd examples/akka-kafka-example
35+
mvn clean package
36+
export SUPERSTREAM_TOPICS_LIST=example-topic
37+
java -javaagent:../../target/superstream-clients-1.0.0.jar -jar target/akka-kafka-example-1.0.0-jar-with-dependencies.jar
38+
```
39+
40+
## Building the Clients Library
41+
42+
### Command Line
43+
44+
```bash
45+
mvn clean package -pl superstream-clients
46+
```
47+
48+
### IntelliJ IDEA
49+
50+
1. Go to View → Tool Windows → Maven
51+
2. Expand `superstream-clients` → Lifecycle
52+
3. Double-click on `install`
53+
54+
55+
## License
56+
57+
Apache License 2.0

superstream-clients/README.md

Lines changed: 0 additions & 144 deletions
This file was deleted.

0 commit comments

Comments
 (0)