Docs update (#3)

* Information about adding a dependency * changelog added
ringcentral · Jan 6, 2021 · 4fa0000 · 4fa0000
1 parent a3ab5be
commit 4fa0000
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,2 @@
+### Version 0.1.2
+First public release. Has no changes compared to 0.1.0 and 0.1.1.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Cassandra 4 io
 
+![CI](https://github.com/ringcentral/cassandra4io/workflows/CI/badge.svg?branch=main)
+
 This is lightweight cats-effect and fs2 IO wrapper for latest datastax 4.x driver.
 
 Why 4.x?
@@ -15,7 +17,15 @@ optimizations, less allocations, metrics improvements, and fully compatible with
 
 
 ## How to use
+Cassandra4io is currently available only for Scala 2.13.
+
+### Add a dependency to your project
+```scala
+resolvers += Resolver.bintrayRepo("ringcentral", "cassandra4io")
+libraryDependencies += ("com.ringcentral" %% "cassandra4io" % "0.1.2")
+```
 
+### Create a connection to Cassandra
 ```scala
 import com.ringcentral.cassandra4io.CassandraSession
 
@@ -34,7 +44,7 @@ def makeSession[F[_]: Async: ContextShift]: Resource[F, CassandraSession[F]] =
   CassandraSession.connect(builder)
 ```
 
-## Typed cql
+### Write some requests
 
 package `com.ringcentral.cassandra4io.cql` introduces typed way to deal with cql queries
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		### Version 0.1.2
		First public release. Has no changes compared to 0.1.0 and 0.1.1.