]> zoso.dev Git - buffer.git/commitdiff
add note about tracking node 0.11 api
authorFeross Aboukhadijeh <feross@feross.org>
Thu, 17 Jul 2014 05:18:35 +0000 (22:18 -0700)
committerFeross Aboukhadijeh <feross@feross.org>
Thu, 17 Jul 2014 05:18:35 +0000 (22:18 -0700)
close #34

README.md

index d6fd8b832813f217dbabe3fed7b6bd152248fb5d..c6cd86c5df701162fa2a6a46c9ed4cc52b551ee7 100644 (file)
--- 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`.