浏览代码

examples/README addition.

Willem van Bergen 10 年之前
父节点
当前提交
e8ecee7f45
共有 1 个文件被更改,包括 2 次插入0 次删除
  1. 2 0
      examples/README.md

+ 2 - 0
examples/README.md

@@ -2,6 +2,8 @@
 
 This folder contains example applications to demonstrate the use of Sarama. For code snippet examples on how to use the different types in Sarama, see [Sarams's API documentation on godoc.org](https://godoc.org/github.com/Shopify/sarama)
 
+In these examples, we use `github.com/Shopify/sarama` as import path. We do this to ensure all the examples are up to date with the latest changes in Sarama. For your own applications, you may want to use `gopkg.in/Shopify/sarama.v1` to lock into a stabnle API version.
+
 #### HTTP server
 
 [http_server](./http_server) is a simple HTTP server uses both the sync producer to produce data as part of the request handling cycle, as well as the async producer to maintain an access log. It also uses the [mocks subpackage](https://godoc.org/github.com/Shopify/sarama/mocks) to test both.