Skip to content

Commit

Permalink
Updates README.me (#289)
Browse files Browse the repository at this point in the history
* docs: use correct name for prop on validator ctx

* docs(mdlint): apply lint rules

* Fix style
  • Loading branch information
big kahuna burger authored and tngan committed Jul 8, 2019
1 parent db0f8cb commit f541d02
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# samlify ·
# samlify ·

[![Build Status](https://travis-ci.org/tngan/samlify.svg?branch=master)](https://travis-ci.org/tngan/samlify)
[![npm version](https://img.shields.io/npm/v/samlify.svg?style=flat)](https://www.npmjs.com/package/samlify)
[![Coverage Status](https://img.shields.io/coveralls/tngan/samlify/master.svg)](https://coveralls.io/github/tngan/samlify?branch=master)
[![Coverage Status](https://img.shields.io/coveralls/tngan/samlify/master.svg)](https://coveralls.io/github/tngan/samlify?branch=master)
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/samlify)

Highly configuarable Node.js SAML 2.0 library for Single Sign On
Highly configuarable Node.js SAML 2.0 library for Single Sign On

### Welcome PRs
## Welcome PRs

Welcome all PRs for maintaining this project, or provide a link to the repositories especially for use cases alongside with different frameworks.

### Sponsor

| <img width="50" src="https://user-images.githubusercontent.com/83319/31722733-de95bbde-b3ea-11e7-96bf-4f4e8f915588.png"> | <div style="text-align: left;">If you want to quickly implement SAML SSO, feel free to check out Auth0's NodeJS SDK and free plan at [auth0.com/overview](https://auth0.com/overview?utm_source=GHsponsor&utm_medium=GHsponsor&utm_campaign=samlify&utm_content=auth).</div> |
|:-------------------------:|:-------------------------|
| :----------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |


### Installation

To install the stable version

Starting from v2.6, multiple schema validators are now supported. You can simply set the validator via the following global method. We have four validator modules right now, and you can write your own. The `setSchemaValidator` is required since v2.6, it will throw error if you don't set at the beginning.
Expand All @@ -39,7 +42,7 @@ Now you can create your own schema validator and even suppress it but you have t

```typescript
samlify.setSchemaValidator({
validator: (response: string) => {
validate: (response: string) => {
/* implment your own or always returns a resolved promise to skip */
return Promise.resolve('skipped');
}
Expand All @@ -49,21 +52,24 @@ samlify.setSchemaValidator({
For those using Windows, `windows-build-tools` should be installed globally before installing samlify if you are using `libxml` validator.

```console
$ yarn global add windows-build-tools
yarn global add windows-build-tools
```

### Development

This project is now developed using TypeScript, also support Yarn which is a new package manager.

```console
$ yarn global add typescript
$ yarn
yarn global add typescript
yarn
```

### Get Started

```javascript
const saml = require('samlify');
```

See full documentation [here](https://samlify.js.org/)

### Example
Expand Down

0 comments on commit f541d02

Please sign in to comment.