readme: updated package description to match the description in gocql readme

This commit is contained in:
Michał Matczuk
2018-05-15 10:21:18 +02:00
parent ecf0820d1d
commit cf3a5ab95f
2 changed files with 7 additions and 12 deletions

View File

@@ -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) # 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®. 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.
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`.
## Installation ## Installation

12
doc.go
View File

@@ -2,10 +2,10 @@
// Use of this source code is governed by a ALv2-style // Use of this source code is governed by a ALv2-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package gocqlx is a productivity toolkit for ScyllaDB and Apache Cassandra®. // Package gocqlx is an idiomatic extension to gocql that provides usability
// It's an extension of `gocql`, similar to what `sqlx` is to `database/sql`. // features. With gocqlx you can bind the query parameters from maps and
// // structs, use named query parameters (:identifier) and scan the query results
// It contains wrappers over gocql types that provide convenience methods which // into structs and slices. It comes with a fluent and flexible CQL query
// are useful in the development of database driven applications. Under the // builder that supports full CQL spec, including BATCH statements and custom
// hood it uses sqlx/reflectx package so sqlx models will also work with gocqlx. // functions.
package gocqlx package gocqlx