Document use of native promises

2 files changed, 21 insertions, 0 deletions

diff --git a/NEWS b/NEWS
index 28bdbaa..7142069 100644
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,18 @@
+# 1.13.0
+
+* Replace the use of bluebird with native promises.
+
+  This is arguably a breaking change: however, the return value of functions
+  such as convertToHtml() was only documented as a promise, rather than as a
+  bluebird promise.
+
+  The only exception is that the docs previously used .done(): therefore,
+  when returning promises from the API to external users, a done method is
+  added.
+
+  Any callers that rely on bluebird promises can convert the returned promise
+  into a bluebird promise using bluebird.Promise.resolve().
+
 # 1.12.3
 
 * Avoid excessive backtracking when parsing an unterminated string with many
diff --git a/README.md b/README.md
index 1d05562..8d0105d 100644
--- a/README.md
+++ b/README.md
@@ -936,6 +936,12 @@ You can nest elements to any depth.
 
 ## Upgrading to later versions
 
+### 1.13.0
+
+The use of bluebird promises has been replaced with native promises. Any callers
+that rely on bluebird promises can convert the returned promise into a bluebird
+promise using bluebird.Promise.resolve().
+
 ### 1.0.0
 
 The `convertUnderline` option is no longer supported.