From 15cd1695d35b21601dc1576b4e4b9228ca91de3e Mon Sep 17 00:00:00 2001 From: Sahat Yalkabov Date: Sun, 17 Jul 2016 18:19:13 -0700 Subject: [PATCH] readme: api updates --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b3f6904c..0e39c2c5 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![npm version](https://badge.fury.io/js/satellizer.svg)](https://badge.fury.io/js/satellizer) [![Book session on Codementor](https://cdn.codementor.io/badges/book_session_github.svg)](https://www.codementor.io/sahatyalkabov?utm_source=github&utm_medium=button&utm_term=sahatyalkabov&utm_campaign=github) -**Live Demo:** http://satellizer-sahat.rhcloud.com +[**Live Demo**]()https://satellizer-sahat.rhcloud.com) --- @@ -42,7 +42,7 @@ in the app *config* block. ## Installation -#### Browser +#### Browser ```html @@ -53,13 +53,13 @@ in the app *config* block. ``` -#### NPM +#### NPM ``` $ npm install satellizer ``` -#### Bower +#### Bower ``` $ bower install satellizer @@ -97,7 +97,7 @@ angular.module('MyApp', ['satellizer']) clientId: 'Facebook App ID' }); - // Optional: For client-side use (Implicit Grant), set responseType to 'token' + // Optional: For client-side use (Implicit Grant), set responseType to 'token' (default: 'code') $authProvider.facebook({ clientId: 'Facebook App ID', responseType: 'token' @@ -192,8 +192,8 @@ $authProvider.signupUrl = '/auth/signup'; $authProvider.unlinkUrl = '/auth/unlink/'; $authProvider.tokenName = 'token'; $authProvider.tokenPrefix = 'satellizer'; -$authProvider.authHeader = 'Authorization'; -$authProvider.authToken = 'Bearer'; +$authProvider.tokenHeader = 'Authorization'; +$authProvider.tokenType = 'Bearer'; $authProvider.storageType = 'localStorage'; // Facebook @@ -818,7 +818,7 @@ As far as Satellizer is concerned, it does not matter what is the value of `redi #### :question: How can I send a token in a format other than `Authorization: Bearer `? If you are unable to send a token to your server in the following format - `Authorization: Bearer `, then use -**`$authProvider.authHeader`** and **`$authProvider.authToken`** config options to change the header format. The default values are `Authorization` and `Bearer`, respectively. +**`$authProvider.tokenHeader`** and **`$authProvider.tokenType`** config options to change the header format. The default values are `Authorization` and `Bearer`, respectively. For example, if you need to use `Authorization: Basic` header, this is where you change it.