From cf3a5ab95fcb206a8d1b02b7ef3583613c53c6f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Matczuk?= Date: Tue, 15 May 2018 10:21:18 +0200 Subject: [PATCH] readme: updated package description to match the description in gocql readme --- README.md | 7 +------ doc.go | 12 ++++++------ 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 519d339..c2cedeb 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,6 @@ # GoCQLX [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/scylladb/gocqlx) [![Go Report Card](https://goreportcard.com/badge/github.com/scylladb/gocqlx)](https://goreportcard.com/report/github.com/scylladb/gocqlx) [![Build Status](https://travis-ci.org/scylladb/gocqlx.svg?branch=master)](https://travis-ci.org/scylladb/gocqlx) -Package `gocqlx` is a productivity toolkit for ScyllaDB and Apache Cassandra®. -It's an extension of `gocql`, similar to what `sqlx` is to `database/sql`. - -It contains wrappers over `gocql` types that provide convenience methods which -are useful in the development of database driven applications. Under the -hood it uses `sqlx/reflectx` package so `sqlx` models will also work with `gocqlx`. +Package `gocqlx` is an idiomatic extension to `gocql` that provides usability features. With gocqlx you can bind the query parameters from maps and structs, use named query parameters (:identifier) and scan the query results into structs and slices. It comes with a fluent and flexible CQL query builder that supports full CQL spec, including BATCH statements and custom functions. ## Installation diff --git a/doc.go b/doc.go index d3b30d5..b5ac6f3 100644 --- a/doc.go +++ b/doc.go @@ -2,10 +2,10 @@ // Use of this source code is governed by a ALv2-style // license that can be found in the LICENSE file. -// Package gocqlx is a productivity toolkit for ScyllaDB and Apache Cassandra®. -// It's an extension of `gocql`, similar to what `sqlx` is to `database/sql`. -// -// It contains wrappers over gocql types that provide convenience methods which -// are useful in the development of database driven applications. Under the -// hood it uses sqlx/reflectx package so sqlx models will also work with gocqlx. +// Package gocqlx is an idiomatic extension to gocql that provides usability +// features. With gocqlx you can bind the query parameters from maps and +// structs, use named query parameters (:identifier) and scan the query results +// into structs and slices. It comes with a fluent and flexible CQL query +// builder that supports full CQL spec, including BATCH statements and custom +// functions. package gocqlx