From ed420779288d0fec5f095f6da7923d09e3108c05 Mon Sep 17 00:00:00 2001 From: Dave Grijalva Date: Tue, 26 Aug 2014 18:22:44 -0700 Subject: [PATCH] Added note about 2.0.0 change. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 852beab..ea388bf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ A [go](http://www.golang.org) (or 'golang' for search engine friendliness) implementation of [JSON Web Tokens](http://self-issued.info/docs/draft-jones-json-web-token.html) +**NOTICE:** We recently introduced a breaking change in the API. Please refer to [VERSION_HISTORY.md](VERSION_HISTORY.md) for details. + ## What the heck is a JWT? In short, it's a signed JSON object that does something useful (for example, authentication). It's commonly used for `Bearer` tokens in Oauth 2. A token is made of three parts, separated by `.`'s. The first two parts are JSON objects, that have been [base64url](http://tools.ietf.org/html/rfc4648) encoded. The last part is the signature, encoded the same way.