Skip to content

Commit 3b6da88

Browse files
committed
nitrite-bridge README: coordinates, and it is a reactor module now
The README explained how to use the adapter and never said how to depend on it. Adds the Maven and Gradle coordinates, both scoped so the artifact stays out of a shipped build, which is the guard the section below it argues for. The build section said dbinspect-bridge was not on Central and this module was therefore out of <modules>. Both halves stopped being true today.
1 parent 64b345c commit 3b6da88

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

‎nitrite-bridge/README.md‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ release guard are in `org.dizitart:dbinspect-bridge`, which knows about no datab
88
JVM developer inspecting an H2, MapDB or JDBC database takes that artifact and writes their own
99
adapter, and nothing about that path routes through a Nitrite repository.
1010

11+
## Install
12+
13+
Keep it out of the artifact you ship — see the next section for why.
14+
15+
```xml
16+
<dependency>
17+
<groupId>org.dizitart</groupId>
18+
<artifactId>nitrite-bridge</artifactId>
19+
<version>5.2.0</version>
20+
<scope>provided</scope>
21+
</dependency>
22+
```
23+
24+
```kotlin
25+
// Android
26+
debugImplementation("org.dizitart:nitrite-bridge:5.2.0")
27+
```
28+
29+
It pulls `org.dizitart:dbinspect-bridge` in with it.
30+
1131
```java
1232
BridgeServer bridge = DbInspect.start(
1333
DbInspect.options("my_app", List.of(
@@ -69,15 +89,15 @@ listed and unopenable.
6989

7090
## Building it
7191

72-
`dbinspect-bridge` is not on Maven Central yet, so this module is deliberately **not** in
73-
`nitrite-java`'s `<modules>` — a clean checkout could not resolve it and the whole reactor would
74-
fail. Install the core, then build this on its own:
92+
An ordinary reactor module since `org.dizitart:dbinspect-bridge 0.1.0` reached Maven Central:
7593

7694
```bash
77-
mvn -f <dbinspect>/jvm/dbinspect-bridge/pom.xml install
7895
mvn -f nitrite-bridge/pom.xml test
7996
```
8097

98+
It was held out of `nitrite-java`'s `<modules>` until then, because a clean checkout could not
99+
resolve the core and the whole reactor failed with it.
100+
81101
## Examples
82102

83103
| Path | What it is |

0 commit comments

Comments
 (0)