Skip to content

Commit a5d84ec

Browse files
Update README.md (#31)
Co-authored-by: ZIO Assistant <zio-assistant[bot]@users.noreply.github.com>
1 parent 7c233da commit a5d84ec

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## Introduction
1212

13-
The goal of this project is to create the best all-round JSON library for Scala:
13+
The goal of this project is to create the best all-round BSON library for Scala:
1414

1515
- **Native BSON support** to avoid intermediate JSON conversions and support BSON types.
1616
- **Future-Proof**, prepared for Scala 3 and next-generation Java.
@@ -23,8 +23,8 @@ The goal of this project is to create the best all-round JSON library for Scala:
2323
In order to use this library, we need to add the following lines in our `build.sbt` file:
2424

2525
```scala
26-
libraryDependencies += "dev.zio" %% "zio-bson" % "1.0.2"
27-
libraryDependencies += "dev.zio" %% "zio-bson-magnolia" % "1.0.2"
26+
libraryDependencies += "dev.zio" %% "zio-bson" % "1.0.4"
27+
libraryDependencies += "dev.zio" %% "zio-bson-magnolia" % "1.0.4"
2828
```
2929

3030
## zio-schema support
@@ -117,9 +117,9 @@ object Fruit {
117117
implicit val codec: BsonCodec[Fruit] = DeriveBsonCodec.derive
118118
}
119119

120-
val jsonFruit = doc( "Banana" -> doc( "curvature" -> double(0.5) ))
120+
val bsonFruit = doc( "Banana" -> doc( "curvature" -> double(0.5) ))
121121

122-
jsonFruit.as[Fruit]
122+
bsonFruit.as[Fruit]
123123
//Right(Banana(0.5))
124124

125125
@bsonDiscriminator("$type")
@@ -133,12 +133,12 @@ object FruitConfigured {
133133
implicit val codec: BsonCodec[FruitConfigured] = DeriveBsonCodec.derive
134134
}
135135

136-
val jsonFruitConfigured = doc(
136+
val bsonFruitConfigured = doc(
137137
"$type" -> str("custom_type_name"),
138138
"is_poisoned" -> bool(true)
139139
)
140140

141-
jsonFruitConfigured.as[FruitConfigured]
141+
bsonFruitConfigured.as[FruitConfigured]
142142
```
143143

144144
## Documentation

0 commit comments

Comments
 (0)