Skip to content

Commit

Permalink
Update README.md and add installation guide for Windows (#129)
Browse files Browse the repository at this point in the history
  • Loading branch information
tngan committed Nov 4, 2017
1 parent fb36823 commit 4b5cfdf
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,17 @@ This module provides high-level API for scalable Single Sign On (SSO) implementa
### Installation
To install the stable version

For those using Windows, `windows-build-tools` should be installed globally before installing samlify.
```bash
yarn global add windows-build-tools
```

```bash
$ npm install samlify --save
$ yarn add samlify
```

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

```bash
$ yarn global add typescript
Expand All @@ -30,6 +34,8 @@ $ yarn
+ [GitLab](https://gitlab.com/)
+ [OneLogin](https://www.onelogin.com/)
+ [Okta](https://www.okta.com/)
+ [Shibboleth](https://www.shibboleth.net/)
+ [SimpleSAMLphp](https://simplesamlphp.org/)

### Get Started
```javascript
Expand Down

0 comments on commit 4b5cfdf

Please sign in to comment.