examples/README addition.

IBM · Mar 19, 2015 · e8ecee7 · e8ecee7
1 parent 9206b73
commit e8ecee7
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/examples/README.md b/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.