Update readme

julianpeeters · Aug 7, 2023 · c3a3f1e · c3a3f1e
1 parent 27baba3
commit c3a3f1e
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
 # schemabuilder4cats
-A referentially transparent FFI to `org.apache.avro.SchemaBuilder`
+ - **Library for Scala 3.3.0 (JVM only)**
+ - **Depends on Avro 1.11.1**
 
-### Welcome to `schemabuilder4cats`
+### Installation
 
-Let's build schemas secure in the knowledge that we won't be causing side-effects.
+Build schemas secure in the knowledge that we won't be causing side-effects.
 
 ##### Add the dependency
 
@@ -13,8 +14,8 @@ Let's build schemas secure in the knowledge that we won't be causing side-effect
 
 ### Usage
 
-The `SchemaBuilder` API is modelled after `org.apache.avro.SchemaBuilder`.
-Please see the corresponding Apache Avro Java 1.11.1 API
+The `SchemaBuilder` API is modelled after Apache Avro Java 1.11.1 API.
+Please see the corresponding `org.apache.avro.SchemaBuilder`
 [Javadoc](https://avro.apache.org/docs/1.11.1/api/java/) for documentation.
 
 ##### Example:
@@ -24,7 +25,7 @@ import cats.effect.IO
 import org.apache.avro.Schema
 import schemabuilder4cats.SchemaBuilder
 
-// define B as a contextual abstraction in order to import extension methodss
+// define B as a contextual abstraction in order to import extension methods
 given B: SchemaBuilder[IO] = SchemaBuilder[IO]
 val record: IO[Schema] = B.record("myrecord").fields.endRecord
 ```

diff --git a/build.sbt b/build.sbt
@@ -2,6 +2,7 @@ lazy val ApacheAvroV = "1.11.1"
 lazy val CatsEffectV = "3.5.1"
 lazy val MUnitCEV = "1.0.7"
 
+ThisBuild / crossScalaVersions := Seq(scalaVersion.value)
 ThisBuild / description := "A referentially transparent FFI to `org.apache.avro.SchemaBuilder`"
 ThisBuild / organization := "com.julianpeeters"
 ThisBuild / scalaVersion := "3.3.0"
@@ -37,7 +38,8 @@ lazy val docs = project.in(file("docs/gitignored"))
     mdocOut := schemabuilder4cats.base,
     mdocVariables := Map(
       "AVRO" -> ApacheAvroV,
-      "VERSION" -> version.value
+      "VERSION" -> version.value,
+      "SCALA" -> crossScalaVersions.value.mkString(", ")
     )
   )
   .dependsOn(schemabuilder4cats)

diff --git a/docs/readme.md b/docs/readme.md
@@ -1,9 +1,10 @@
 # schemabuilder4cats
-A referentially transparent FFI to `org.apache.avro.SchemaBuilder`
+ - **Library for Scala @SCALA@ (JVM only)**
+ - **Depends on Avro @AVRO@**
 
-### Welcome to `schemabuilder4cats`
+### Installation
 
-Let's build schemas secure in the knowledge that we won't be causing side-effects.
+Build schemas secure in the knowledge that we won't be causing side-effects.
 
 ##### Add the dependency
 
@@ -13,8 +14,8 @@ Let's build schemas secure in the knowledge that we won't be causing side-effect
 
 ### Usage
 
-The `SchemaBuilder` API is modelled after `org.apache.avro.SchemaBuilder`.
-Please see the corresponding Apache Avro Java @AVRO@ API
+The `SchemaBuilder` API is modelled after Apache Avro Java @AVRO@ API.
+Please see the corresponding `org.apache.avro.SchemaBuilder`
 [Javadoc](https://avro.apache.org/docs/@AVRO@/api/java/) for documentation.
 
 ##### Example:
@@ -24,7 +25,7 @@ import cats.effect.IO
 import org.apache.avro.Schema
 import schemabuilder4cats.SchemaBuilder
 
-// define B as a contextual abstraction in order to import extension methodss
+// define B as a contextual abstraction in order to import extension methods
 given B: SchemaBuilder[IO] = SchemaBuilder[IO]
 val record: IO[Schema] = B.record("myrecord").fields.endRecord
 ```