diff --git a/README.md b/README.md index 37177bc..1c5b25f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,19 @@ GocqlX makes working with Scylla easy and less error-prone. It’s inspired by [Sqlx](https://github.com/jmoiron/sqlx), a tool for working with SQL databases, but it goes beyond what Sqlx provides. +## Compatibility + +Versions of GocqlX prior to v3.0.0 are compatible with both [Apache Cassandra’s gocql](https://github.com/apache/cassandra-gocql-driver) and [ScyllaDB’s fork](https://github.com/scylladb/gocql). +However, starting with v3.0.0, GocqlX exclusively supports the scylladb/gocql driver. +If you are using GocqlX v3.0.0 or newer, you must ensure your `go.mod` includes a replace directive to point to ScyllaDB’s fork: + +```go +# Use the latest version of scylladb/gocql; check for updates at https://github.com/scylladb/gocql/releases +replace github.com/gocql/gocql => github.com/scylladb/gocql v1.15.1 +``` + +This is required because GocqlX relies on ScyllaDB-specific extensions and bug fixes introduced in the gocql fork. Attempting to use the standard gocql driver with GocqlX v3.0.0+ may lead to build or runtime issues. + ## Features * Binding query parameters from struct fields, map, or both