Skip to content

Commit e747f16

Browse files
committed
Undocument the "replace Fahrschein completely" feature
This way, it doesn't enter the contract.
1 parent 070698e commit e747f16

File tree

1 file changed

+2
-22
lines changed

1 file changed

+2
-22
lines changed

README.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,16 @@ The library uses flyway migrations to set up its own database schema `nakadi_eve
8585

8686
### Nakadi communication configuration
8787

88-
By default, Nakadi-producer-spring-boot starter uses the Fahrschein library to submit its events. It needs some configuration to know how to do this – we describe three ways here (basically in order of ease of use):
88+
By default, Nakadi-producer-spring-boot starter uses the Fahrschein library to submit its events. It needs some configuration to know how to do this – we support two ways:
8989

9090
* Using existing Fahrschein setup
9191
* Letting this library set things up
92-
* Implement Nakadi communication yourself
9392

9493
#### Using existing Fahrschein setup
9594

9695
If you are already using the [Fahrschein library](https://github.com/zalando-nakadi/fahrschein) directly (e.g. for event consumption) and have already a configured `org.zalando.fahrschein.NakadiClient` object, just make sure it is available as a Spring bean. Nakadi-Producer-Spring-Boot-Starter will pick it up and use it directly.
9796

98-
The configurations in the next section are then not needed at all.
97+
The configuration in the next section is then not needed at all.
9998

10099
#### Letting this library set things up
101100

@@ -137,25 +136,6 @@ nakadi-producer:
137136

138137
If you do not use the STUPS Tokens library, you can implement token retrieval yourself by defining a Spring bean of type `org.zalando.nakadiproducer.AccessTokenProvider`. The starter will detect it and call it once for each request to retrieve the token.
139138

140-
#### Implement Nakadi communication yourself
141-
142-
If you don't like Fahrschein, you can implement the communication with Nakadi yourself. Just provide an implementation of the `NakadiPublishingClient` interface as a Spring bean. Nakadi-producer-spring-boot-starter will just use that bean. (This is used in the [test support](#test-support) described below.)
143-
144-
You can then also exclude the Fahrschein dependency:
145-
146-
```xml
147-
<dependency>
148-
<groupId>org.zalando</groupId>
149-
<artifactId>nakadi-producer-spring-boot-starter</artifactId>
150-
<version>${nakadi-producer.version}</version>
151-
<exclusions>
152-
<exclusion>
153-
<groupId>org.zalando</groupId>
154-
<artifactId>fahrschein</artifactId>
155-
<exclusion>
156-
</exclusions>
157-
</dependency>
158-
```
159139

160140
### Creating events
161141

0 commit comments

Comments
 (0)