Skip to content

Commit c63ce54

Browse files
committed
bson: document mongo specific behaviour
1 parent 8bb407c commit c63ce54

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

bson/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@ An Implementation of BSON for Go
55

66
Package bson is an implementation of the [BSON specification](http://bsonspec.org) for Go.
77

8-
It was created as part of the mgo MongoDB driver for Go, but is standalone
9-
and may be used on its own without the driver.
8+
While the BSON package implements the BSON spec as faithfully as possible, there
9+
is some MongoDB specific behaviour (such as map keys `$in`, `$all`, etc) in the
10+
`bson` package. The priority is for backwards compatibility for the `mgo`
11+
driver, though fixes for obviously buggy behaviour is welcome (and features, etc
12+
behind feature flags).

0 commit comments

Comments
 (0)