Skip to content

Commit 6ad2c85

Browse files
committed
chore: minor edits to README.md, ignore package-lock.json
1 parent 5c263de commit 6ad2c85

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules
2-
.DS_Store
2+
.DS_Store
3+
package-lock.json

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
Create SAML assertions.
1+
# node-saml
22

3-
NOTE: currently supports SAML 1.1 tokens
3+
Create SAML assertions. Supports SAML 1.1 and SAML 2.0 tokens.
44

55
[![Build Status](https://travis-ci.org/auth0/node-saml.png)](https://travis-ci.org/auth0/node-saml)
66

77
### Usage
88

99
```js
10-
var saml11 = require('saml').Saml11;
10+
var saml = require('saml').Saml20; // or Saml11
1111

1212
var options = {
1313
cert: fs.readFileSync(__dirname + '/test-auth0.pem'),
@@ -23,7 +23,7 @@ var options = {
2323
sessionIndex: '_faed468a-15a0-4668-aed6-3d9c478cc8fa'
2424
};
2525

26-
var signedAssertion = saml11.create(options);
26+
var signedAssertion = saml.create(options);
2727
```
2828

2929
Everything except the cert and key is optional.

0 commit comments

Comments
 (0)