Skip to content

Commit 613a15c

Browse files
committed
Fixed documentation
1 parent a187498 commit 613a15c

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
66

77
### Fixed
88
- Corrected protobuf import
9+
- Fixed documentation
910

1011
## v1.1.0
1112
### Added

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# GoRethink - RethinkDB Driver for Go
22

3-
**Driver does not currently support RethinkDB 2.1, update coming soon!**
4-
53
[![GitHub tag](https://img.shields.io/github/tag/dancannon/gorethink.svg?style=flat)](https://github.com/dancannon/gorethink/releases)
64
[![GoDoc](https://godoc.org/github.com/dancannon/gorethink?status.png)](https://godoc.org/github.com/dancannon/gorethink)
75
[![build status](https://img.shields.io/travis/dancannon/gorethink/master.svg "build status")](https://travis-ci.org/dancannon/gorethink)
@@ -188,7 +186,7 @@ if err != nil {
188186
}
189187
```
190188

191-
## Encoding/Decoding Structs
189+
## Encoding/Decoding
192190
When passing structs to Expr(And functions that use Expr such as Insert, Update) the structs are encoded into a map before being sent to the server. Each exported field is added to the map unless
193191

194192
- the field's tag is "-", or
@@ -215,6 +213,8 @@ Field int `gorethink:",omitempty"`
215213

216214
**NOTE:** It is strongly recommended that struct tags are used to explicitly define the mapping between your Go type and how the data is stored by RethinkDB. This is especially important when using an `Id` field as by default RethinkDB will create a field named `id` as the primary key (note that the RethinkDB field is lowercase but the Go version starts with a capital letter).
217215

216+
When encoding maps with non-string keys the key values are automatically converted to strings where possible, however it is recommended that you use strings where possible (for example `map[string]T`).
217+
218218
## Benchmarks
219219

220220
Everyone wants their project's benchmarks to be speedy. And while we know that rethinkDb and the gorethink driver are quite fast, our primary goal is for our benchmarks to be correct. They are designed to give you, the user, an accurate picture of writes per second (w/s). If you come up with a accurate test that meets this aim, submit a pull request please.

0 commit comments

Comments
 (0)