diff --git a/ChangeLog.md b/ChangeLog.md index 29c38f31..a0c7b9d7 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,19 +1,18 @@ ## go-nsq Change Log -### 1.0.0-alpha +### 1.0.0 - 2014-08-11 -**Upgrading from 0.3.7**: The public API was refactored considerably and is not backwards +**Upgrading from 0.3.7**: The public API was significantly refactored and is not backwards compatible, please read [UPGRADING](UPGRADING.md). - * #58 - support IDENTIFY `msg_timeout` - * #54 - per-connection TLS config and set ServerName - * #45 - fix producer connect/close race + * #58 - support `IDENTIFY` `msg_timeout` + * #54 - per-connection TLS config and set `ServerName` * #49 - add common connect helpers - * #43 - more flexible nsqlookupd URL specification - * #35 - AUTH support - * #41 - use package private RNG - * #36 - support 64char topic/channel names - * #30/#38/#39/#42/#46/#48/#51/#52 - refactor public API (see [UPGRADING](UPGRADING.md)) + * #43/#63 - more flexible `nsqlookupd` URL specification + * #35 - `AUTH` support + * #41/#62 - use package private RNG + * #36 - support 64 character topic/channel names + * #30/#38/#39/#42/#45/#46/#48/#51/#52/#65/#70 - refactor public API (see [UPGRADING](UPGRADING.md)) ### 0.3.7 - 2014-05-25 diff --git a/README.md b/README.md index 8a3b269c..816ee0fa 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,20 @@ ## go-nsq -`go-nsq` is the official Go package for [NSQ][nsq]. +The official Go package for [NSQ][nsq]. -NOTE: The public API has been refactored in anticipation of `v1.0.0` and is not backwards compatible with -previous releases. **[0.3.7][legacy]** is the last stable release compatible with the legacy API. Please -read the [UPGRADING](UPGRADING.md) guide. +[![Build Status](https://secure.travis-ci.org/bitly/go-nsq.png?branch=master)][travis] [![GoDoc](https://godoc.org/github.com/bitly/go-nsq?status.svg)](https://godoc.org/github.com/bitly/go-nsq) -The latest stable release is **[0.3.7][latest_tag]** +NOTE: The public API has been refactored as of `v1.0.0` and is not backwards compatible with +previous releases. **[0.3.7][legacy]** is the last stable release compatible with the legacy API. +Please read the [UPGRADING](UPGRADING.md) guide. -[![Build Status](https://secure.travis-ci.org/bitly/go-nsq.png?branch=master)][travis] - -It provides high-level [Consumer][consumer] and [Producer][producer] types as well as low-level -functions to communicate over the [NSQ protocol][protocol]. - -See the [main repo apps][apps] directory for examples of clients built using this package. - -### Installing - - $ go get github.com/bitly/go-nsq +The latest stable release is **[1.0.0][latest_tag]** ### Docs -See [godoc][nsq_gopkgdoc] for pretty documentation or: +See [godoc][nsq_gopkgdoc]. - # in the go-nsq package directory - $ go doc +See the [main repo apps][apps] directory for examples of clients built using this package. [nsq]: https://github.com/bitly/nsq [nsq_gopkgdoc]: http://godoc.org/github.com/bitly/go-nsq @@ -35,4 +25,4 @@ See [godoc][nsq_gopkgdoc] for pretty documentation or: [pr30]: https://github.com/bitly/go-nsq/pull/30 [legacy]: https://github.com/bitly/go-nsq/releases/tag/v0.3.7 [travis]: http://travis-ci.org/bitly/go-nsq -[latest_tag]: https://github.com/bitly/go-nsq/releases/tag/v0.3.7 +[latest_tag]: https://github.com/bitly/go-nsq/releases/tag/v1.0.0 diff --git a/UPGRADING.md b/UPGRADING.md index 6c0e11da..d229aaaa 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -163,8 +163,10 @@ exposing an interface that follows the standard library and still provides a mea configure the output. In the new API, we've provided a method on `Consumer` and `Producer` called `SetLogger` that takes -a Go standard library `log.Logger` (which can be instantiated via `log.NewLogger`) and a -traditional log level integer `nsq.LogLevel{Debug,Info,Warning,Error}`. +an interface compatible with the Go standard library `log.Logger` (which can be instantiated via +`log.NewLogger`) and a traditional log level integer `nsq.LogLevel{Debug,Info,Warning,Error}`: + + Output(maxdepth int, s string) error This gives the user the flexibility to control the format, destination, and verbosity while still conforming to standard library logging conventions. diff --git a/version.go b/version.go index 16aa0089..14957a97 100644 --- a/version.go +++ b/version.go @@ -5,4 +5,4 @@ package nsq // VERSION -const VERSION = "1.0.0-alpha" +const VERSION = "1.0.0"