From 280f749ac08549d7a12492113660cb7e25384297 Mon Sep 17 00:00:00 2001
From: Jon Carstens <jjcarstens@me.com>
Date: Tue, 9 Mar 2021 10:37:44 -0700
Subject: [PATCH] v0.10.0 add note about potential breaking change

---
 CHANGELOG.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 28bc057..2a1782e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,13 @@
 
 * `nerves_hub_link_common 0.2.0`
 
+* Potential Breaking Changes
+  * This enforces the update data structure exchanged between device and server
+    and is mostly internal. However, if you implement your own `NervesHubLink.Client`
+    behavior, then you will need to your `NervesHubLink.Client.update_available/1` to
+    accept a `%NervesHubLinkCommon.Message.UpdateInfo{}` struct as the parameter
+    instead of a map with string keys which was used until this point.
+
 * Enhancements
   * Report API version to NervesHub. While there's currently only one version of
     the Device API, this is anticipation that we may want to change it in the future.