From 57cc7c3ce5ea39c5e8c96462640e7ba03d473bc9 Mon Sep 17 00:00:00 2001 From: Arthur Barr Date: Tue, 8 May 2018 13:34:22 +0100 Subject: [PATCH] include notice about versioning dependencies --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 260b209..8fd2f14 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # mq-golang This repository demonstrates how you can call IBM MQ from applications written in the Go language. +> **NOTICE**: Please ensure that you use a dependency management tool such as [dep](https://github.com/golang/dep) or [Glide](http://glide.sh/), and add a specific version dependency. The current content has been marked as version 1.0.0, and a new version with breaking changes will be released soon. By using a dependency manager, you can continue to use the old version if you want to. + The repository also includes programs to export MQ statistics to some monitoring packages including Prometheus, InfluxDB and OpenTSDB. @@ -9,6 +11,11 @@ The monitoring data published by the queue manager is not available before that version; the interface also assumes availability of MQI structures from that level of MQ. +## Health Warning + +This package is provided as-is with no guarantees of support or updates. There are also no guarantees of compatibility +with any future versions of the package; the API is subject to change based on any feedback. + ## MQI Description The ibmmq directory contains a Go package, exposing an MQI-like interface. @@ -124,11 +131,6 @@ There are also no structure handlers for message headers such as MQRFH2 or MQDLH See [CHANGES](CHANGES.md) in this directory. -## Health Warning - -This package is provided as-is with no guarantees of support or updates. There are also no guarantees of compatibility -with any future versions of the package; the API is subject to change based on any feedback. - ## Issues and Contributions For feedback and issues relating specifically to this package, please use the [GitHub issue tracker](https://github.com/ibm-messaging/mq-golang/issues).