Skip to content

Commit

Permalink
Update README to reflect addition of async sign
Browse files Browse the repository at this point in the history
To document changes from #127
  • Loading branch information
Luke Westby committed Oct 2, 2015
1 parent 9414fbc commit d661d4b
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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])
Expand Down

0 comments on commit d661d4b

Please sign in to comment.