simple readme and example_test
This commit is contained in:
20
README.md
20
README.md
@@ -1 +1,21 @@
|
||||
# gocqlx [](http://godoc.org/github.com/mmatczuk/gocqlx) [](https://goreportcard.com/report/github.com/mmatczuk/gocqlx) [](https://travis-ci.org/mmatczuk/gocqlx)
|
||||
|
||||
Package `gocqlx` is a `gocql` extension, similar to what `sqlx` is to `database/sql`.
|
||||
|
||||
It provides a new type that seamlessly wraps `gocql.Iter` and provide
|
||||
convenience methods which are useful in the development of database driven
|
||||
applications. None of the underlying gocql.Iter methods are changed.
|
||||
Instead all extended behavior is implemented through new methods defined on
|
||||
wrapper type.
|
||||
|
||||
The wrapper type enables you to bind iterator row into a struct. Under the
|
||||
hood it uses `sqlx/reflectx` package, models / structs working whit `sqlx` will
|
||||
also work with `gocqlx`.
|
||||
|
||||
## Installation
|
||||
|
||||
go get github.com/mmatczuk/gocqlx
|
||||
|
||||
## Example
|
||||
|
||||
See [example test](https://github.com/mmatczuk/gocqlx/blob/master/example_test.go).
|
||||
|
||||
Reference in New Issue
Block a user