Skip to content

Commit

Permalink
more improvements to README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Alfredo Gutierrez <[email protected]>
  • Loading branch information
AlfredoG87 committed Aug 14, 2024
1 parent e4a8ebf commit 3ba979a
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,30 @@ Please do not file a public ticket mentioning the vulnerability. Refer to the se

---

# Configuration
# Usage

## Configuration

| Environment Variable | Description | Default Value |
|---------------------------------|---------------------------------------------------------------------------------------------------------------|---------------|
| persistence.storage.rootPath | The root path for the storage, if not provided will attempt to create a `data` on the working dir of the app. | ./data |
| consumer.timeoutThresholdMillis | Time to wait for subscribers before disconnecting in milliseconds | 1500 |

3) To run in debug mode:


# Staring locally:
```bash
./gradlew run
```

In debug mode, you can attach a debugger to the port 5005.
```bash
./gradlew run --debug-jvm
```

Also you can run on docker locally:
```bash
./gradlew run # ./gradlew run --debug-jvm to run in debug mode
./gradlew startDockerContainer
```

# Running Tests
Expand Down

0 comments on commit 3ba979a

Please sign in to comment.