Skip to content

Commit

Permalink
* commented out parts of README.md which are not yet part of the code
Browse files Browse the repository at this point in the history
  • Loading branch information
benedeki committed Nov 6, 2024
1 parent ca2116b commit e5e6f63
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,9 +165,14 @@ Reader module support several asynchronous http clients. The dependencies used f
so the user of the module can decide which client to use and include only the necessary dependencies.

The clients are:
#### Future based `HttpClientServerConnection`
Uses `java.net.http.HttpClient` to send requests to the server, therefore requires no additional dependencies. But works
only with Java 11 or higher.

[//]: # (TODO #298 needs Java 11 cross-build)

[//]: # (#### Future based `HttpClientServerConnection`)

[//]: # (Uses `java.net.http.HttpClient` to send requests to the server, therefore requires no additional dependencies. But works )

[//]: # (only with Java 11 or higher. )

#### Future based `ArmeririaServerConnection`
Add
Expand All @@ -187,13 +192,21 @@ Add
"
to your dependencies.

#### ZIO based `HttpClientServerConnection`
Add
```scala
"com.softwaremill.sttp.client3" %% "zio" % "[version]" // for ZIO 2.x
"com.softwaremill.sttp.client3" %% "zio1" % "[version]" // for ZIO 1.x
```
to your dependencies.
[//]: # (TODO #298 needs Java 11 cross-build)

[//]: # (#### ZIO based `HttpClientServerConnection`)

[//]: # (Add)

[//]: # (```scala)

[//]: # ("com.softwaremill.sttp.client3" %% "zio" % "[version]" // for ZIO 2.x)

[//]: # ("com.softwaremill.sttp.client3" %% "zio1" % "[version]" // for ZIO 1.x)

[//]: # (```)

[//]: # (to your dependencies.)

#### ZIO based `ArmeririaServerConnection`
Add
Expand Down

0 comments on commit e5e6f63

Please sign in to comment.