Skip to content

Commit 077d36a

Browse files
committed
docs: Regenerate mdoc documentation
1 parent 2963034 commit 077d36a

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Creating a simple HTTP server is as easy as this:
99

1010
#### build.sbt
1111

12-
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/avast/scala-server-toolkit?label=version&sort=semver)
12+
![Maven Central](https://img.shields.io/maven-central/v/com.avast/scala-server-toolkit-pureconfig_2.13)
1313

14-
`libraryDependencies += "com.avast.server.toolkit" %% "scala-server-toolkit-pureconfig" % "<VERSION>"`
14+
`libraryDependencies += "com.avast" %% "scala-server-toolkit-pureconfig" % "<VERSION>"`

docs/pureconfig.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Module PureConfig
22

3-
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/avast/scala-server-toolkit?label=version&sort=semver)
3+
![Maven Central](https://img.shields.io/maven-central/v/com.avast/scala-server-toolkit-pureconfig_2.13)
44

5-
`libraryDependencies += "com.avast.server.toolkit" %% "scala-server-toolkit-pureconfig" % "<VERSION>"`
5+
`libraryDependencies += "com.avast" %% "scala-server-toolkit-pureconfig" % "<VERSION>"`
66

77
This module allows you to load your application's configuration file according to a case class provided to it. It uses
88
[PureConfig](https://pureconfig.github.io) library to do so which uses [Lightbend Config](https://github.com/lightbend/config) which means
99
that your application's configuration will be in [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) format.
1010

11+
Loading of configuration is side-effectful so it is wrapped in `F` which is `Sync`. This module also tweaks the error messages a little.
1112

1213
```scala
1314
import com.avast.server.toolkit.pureconfig._
@@ -19,9 +20,9 @@ import zio.Task
1920
final case class ServerConfiguration(listenAddress: String, listenPort: Int)
2021

2122
implicit val serverConfigurationReader: ConfigReader[ServerConfiguration] = deriveReader
22-
// serverConfigurationReader: ConfigReader[ServerConfiguration] = pureconfig.generic.DerivedConfigReader1$$anon$3@662e5590
23+
// serverConfigurationReader: ConfigReader[ServerConfiguration] = pureconfig.generic.DerivedConfigReader1$$anon$3@7d4e424e
2324

2425
val maybeConfiguration = PureConfigModule.make[Task, ServerConfiguration]
25-
// maybeConfiguration: Task[Either[cats.data.NonEmptyList[String], ServerConfiguration]] = zio.ZIO$EffectPartial@606f0f70
26+
// maybeConfiguration: Task[Either[cats.data.NonEmptyList[String], ServerConfiguration]] = zio.ZIO$EffectPartial@e2498a3
2627
```
2728

0 commit comments

Comments
 (0)