Minor documentation updates (globalsign#141)

* docs: updated readme and docs

* docs: added minimal readme for bson package

README.md

@@ -3,10 +3,19 @@
 The MongoDB driver for Go
 -------------------------
 
-This fork has had a few improvements by ourselves as well as several PR's merged from the original mgo repo that are currently awaiting review. Changes are mostly geared towards performance improvements and bug fixes, though a few new features have been added.
+This is the "official", maintained fork of `mgo` (pronounced as "mango").
+We are grateful for the great work that @niemeyer and the mgo contributors have made over the years.
+
+This fork has had a few improvements by ourselves as well as several PR's merged from the original mgo repo that are currently awaiting review.
+Changes are mostly geared towards performance improvements and bug fixes, though a few new features have been added.
 
 Further PR's (with tests) are welcome, but please maintain backwards compatibility.
 
+Detailed documentation of the API is available at
+[GoDoc](https://godoc.org/github.com/globalsign/mgo).
+
+A [sub-package](https://godoc.org/github.com/globalsign/mgo/bson) that implements [BSON](http://bsonspec.org) is also included, and may be used independently of the driver.
+
 ## Changes
 * Fixes attempting to authenticate before every query ([details](https://github.com/go-mgo/mgo/issues/254))
 * Removes bulk update / delete batch size limitations ([details](https://github.com/go-mgo/mgo/issues/288))
@@ -15,13 +24,13 @@ Further PR's (with tests) are welcome, but please maintain backwards compatibili
 * Support majority read concerns ([details](https://github.com/globalsign/mgo/pull/2))
 * Improved connection handling ([details](https://github.com/globalsign/mgo/pull/5))
 * Hides SASL warnings ([details](https://github.com/globalsign/mgo/pull/7))
-* Support for partial indexes ([detials](https://github.com/domodwyer/mgo/commit/5efe8eccb028238d93c222828cae4806aeae9f51))
-* Fixes timezone handling ([details](https://github.com/go-mgo/mgo/pull/464)) 
+* Support for partial indexes ([details](https://github.com/domodwyer/mgo/commit/5efe8eccb028238d93c222828cae4806aeae9f51))
+* Fixes timezone handling ([details](https://github.com/go-mgo/mgo/pull/464))
 * Integration tests run against MongoDB 3.2 & 3.4 releases ([details](https://github.com/globalsign/mgo/pull/4), [more](https://github.com/globalsign/mgo/pull/24), [more](https://github.com/globalsign/mgo/pull/35))
 * Improved multi-document transaction performance ([details](https://github.com/globalsign/mgo/pull/10), [more](https://github.com/globalsign/mgo/pull/11), [more](https://github.com/globalsign/mgo/pull/16))
 * Fixes cursor timeouts ([details](https://jira.mongodb.org/browse/SERVER-24899))
 * Support index hints and timeouts for count queries ([details](https://github.com/globalsign/mgo/pull/17))
-* Don't panic when handling indexed `int64` fields ([detials](https://github.com/go-mgo/mgo/issues/475))
+* Don't panic when handling indexed `int64` fields ([details](https://github.com/go-mgo/mgo/issues/475))
 * Supports dropping all indexes on a collection ([details](https://github.com/globalsign/mgo/pull/25))
 * Annotates log entries/profiler output with optional appName on 3.4+ ([details](https://github.com/globalsign/mgo/pull/28))
 * Support for read-only [views](https://docs.mongodb.com/manual/core/views/) in 3.4+ ([details](https://github.com/globalsign/mgo/pull/33))
@@ -57,4 +66,4 @@ Further PR's (with tests) are welcome, but please maintain backwards compatibili
 * @Reenjii
 * @smoya
 * @steve-gray
-* @wgallagher
+* @wgallagher

bson/README.md

@@ -0,0 +1,9 @@
+[![GoDoc](https://godoc.org/github.com/globalsign/mgo/bson?status.svg)](https://godoc.org/github.com/globalsign/mgo/bson)
+
+An Implementation of BSON for Go
+--------------------------------
+
+Package bson is an implementation of the [BSON specification](http://bsonspec.org) for Go.
+
+It was created as part of the mgo MongoDB driver for Go, but is standalone
+and may be used on its own without the driver.

doc.go

@@ -1,9 +1,8 @@
-// Package mgo offers a rich MongoDB driver for Go.
+// Package mgo (pronounced as "mango") offers a rich MongoDB driver for Go.
 //
-// Details about the mgo project (pronounced as "mango") are found
-// in its web page:
+// Detailed documentation of the API is available at GoDoc:
 //
-//     http://labix.org/mgo
+//     https://godoc.org/github.com/globalsign/mgo
 //
 // Usage of the driver revolves around the concept of sessions.  To
 // get started, obtain a session using the Dial function:
@@ -26,6 +25,11 @@
 // of its life time, so its resources may be put back in the pool or
 // collected, depending on the case.
 //
+// There is a sub-package that provides support for BSON, which can be
+// used by itself as well:
+//
+//    https://godoc.org/github.com/globalsign/mgo/bson
+//
 // For more details, see the documentation for the types and methods.
 //
 package mgo