Skip to content
This repository was archived by the owner on Nov 25, 2020. It is now read-only.

Commit

Permalink
Merge pull request #83 from AdamWillden/doc-readme-updates
Browse files Browse the repository at this point in the history
doc(readme): add how this differs from 'paulvanbladel/aurelia-auth'
  • Loading branch information
doktordirk committed Apr 1, 2016
2 parents 40259e6 + 966a5bf commit c6af3e1
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,18 @@ Spoonx/aurelia-authentication makes use of [aurelia-api](https://github.com/Spoo

![Authentication header](./pictures/authHeader.png)

## How this differs from 'paulvanbladel/aurelia-auth'

This repository was originally a fork of paulvanbladel/aurealia-auth. It was forked when the original repository was in a period of inactivity, and later made into a repository of it's own. As such we often get asked how this repository differs from the original. So, at the time of writing the differences are as follows:

- Provides the option to use endpoints, introduced by [spoonx/aurelia-api](https://github.com/SpoonX/aurelia-api), which simplifies API access.
- By using aurelia-api the developer can specify which endpoints require the authentication patch.
- TypeScript support added through the addition of d.ts (typescript definition) files
- Lots of bug fixes
- Refactored code to be more readable and performant

**Aside:** Public SpoonX repositories are open to the community and actively maintained and used by the SpoonX company. They follow a strict deploy cycle with reviews and follow semantic versioning. This ensures code quality control and long term commitment.

## Installation
We assume that you know about ([NodeJs](https://nodejs.org/), [Gulp](http://gulpjs.com/)) and [Aurelia](http://aurelia.io/).
Since aurelia-authentication is an [Aurelia plugin](https://github.com/aurelia/skeleton-plugin), we also assume that you have your [Aurelia](http://aurelia.io/) project up and running.
Expand Down

0 comments on commit c6af3e1

Please sign in to comment.