From: Feross Aboukhadijeh <feross@feross.org>
Date: Thu, 17 Jul 2014 05:18:35 +0000 (-0700)
Subject: add note about tracking node 0.11 api
X-Git-Url: https://zoso.dev/?a=commitdiff_plain;h=f1125449ebaa8d2947cb0f3757961425d278cb21;p=buffer.git

add note about tracking node 0.11 api

close #34
---

diff --git a/README.md b/README.md
index d6fd8b8..c6cd86c 100644
--- a/README.md
+++ b/README.md
@@ -80,6 +80,15 @@ This works correctly in browsers with typed array support (\* with the exception
 bug](https://bugzilla.mozilla.org/show_bug.cgi?id=952403) that made it impossible to add properties to a typed array.*
 
 
+## tracking the node api
+
+This module tracks the Buffer API in the latest (unstable) version of node.js. The Buffer
+API is considered **stable** in the
+[node stability index](http://nodejs.org/docs/latest/api/documentation.html#documentation_stability_index),
+so it is unlikely that there will ever be breaking changes.
+Nonetheless, when/if the Buffer API changes in node, this module's API will change
+accordingly.
+
 ## performance
 
 See perf tests in `/perf`.