Update README to reflect addition of async sign

To document changes from #127
This commit is contained in:
Luke Westby
2015-10-02 08:55:34 -05:00
parent 9414fbcb15
commit d661d4b6f6
+8 -1
View File
@@ -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])