summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorElmer Thomas <elmer@ThinkingSerious.com>2016-05-12 14:24:50 -0700
committerElmer Thomas <elmer@ThinkingSerious.com>2016-05-12 14:24:50 -0700
commit07d736ece1d70e385497c02433af1ffcdac17854 (patch)
tree6b926e97dee2d767f9dbd8ff670d3e1bff38578e
parent0cf806985869ac7d17e3e164f8c6eb6d4485b4b9 (diff)
downloadsendgrid-nodejs-07d736ece1d70e385497c02433af1ffcdac17854.zip
sendgrid-nodejs-07d736ece1d70e385497c02433af1ffcdac17854.tar.gz
sendgrid-nodejs-07d736ece1d70e385497c02433af1ffcdac17854.tar.bz2
Update README.md
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index f866743..dfac1af 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
+# Special Announcement
+
+We have released a [v3 beta branch](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta) for this library that supports our new v3 Mail Send endpoint which is in open beta. The v3/mail/send/beta endpoint is not a production endpoint, so you should not integrate with it for your production email sending. However, when we make this an officially released feature it will be available at v3/mail/send.
+
+Please try it out and let us know what you think about the endpoint and the library in the [issues area of this repo](https://github.com/sendgrid/sendgrid-nodejs/issues), all of your feedback will be taken into account to influence the endpoint and this library.
+
+Beginning with v3/mail/send/beta, the new version of our library will only support v3 endpoints.. Once this endpoint is out of beta, we will update the endpoint, removing the “/beta” from the URI. At this point, the v3 beta branch will be merged to master and will be our official library going forward. This means that we will no longer formally support the v2 mail.send.json endpoint in any of our libraries.
+
+So long as you are not automatically pulling new versions of the library into your production code base, your integration will not break regardless of which endpoint you’re using. By the way, don't pull new versions into your production code base, because breaking changes break things.
+
+The /api/mail.send.json endpoint, known as v2 mail send, is NOT going away. It will continue to work as it always has, happily sending your emails along as if nothing happened.
+
# SendGrid-nodejs
This nodejs module allows you to quickly and easily send emails through SendGrid using [nodejs](http://nodejs.org/).