From d661d4b6f68eb417834c99b36769444723041ccf Mon Sep 17 00:00:00 2001 From: Luke Westby Date: Fri, 2 Oct 2015 08:55:34 -0500 Subject: [PATCH] Update README to reflect addition of async sign To document changes from #127 --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4bdc8941..03f9029b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,9 @@ $ npm install jsonwebtoken # Usage -### jwt.sign(payload, secretOrPrivateKey, options) +### jwt.sign(payload, secretOrPrivateKey, options, [callback]) + +(Asynchronous) If a callback is supplied, callback is called with the JsonWebToken string (Synchronous) Returns the JsonWebToken as string @@ -51,6 +53,11 @@ var token = jwt.sign({ foo: 'bar' }, 'shhhhh'); // sign with RSA SHA256 var cert = fs.readFileSync('private.key'); // get private key var token = jwt.sign({ foo: 'bar' }, cert, { algorithm: 'RS256'}); + +// sign asynchronously +jwt.sign({ foo: 'bar' }, cert, { algorithm: 'RS256' }, function(token) { + console.log(token); +}); ``` ### jwt.verify(token, secretOrPublicKey, [options, callback])