add note about v2.x API

intellinote · Feb 16, 2018 · fc7bbf7 · fc7bbf7
1 parent b0e44f6
commit fc7bbf7
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,13 @@
 
 <!-- tocstop -->
 
+## PLEASE NOTE:
+
+Version 2.x of `amqp-util` changes some parts of the API but this README file currently describes the amqp-util v1.x.
+
+In the meantime please see the comments in `amqp-consumer.coffee`, `amqp-producer.coffee` and `amqp-base.coffee` for details and examples for the new API.
+
+
 ## Installing
 
 ### Via npm