From 20769085d4b54d44fc3e527e77be7b1060f14780 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kasper=20Rynning-T=C3=B8nnesen?= Date: Thu, 30 Jun 2016 13:49:00 +0200 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++--------------------- 1 file changed, 11 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 3869fb2..b47681c 100644 --- a/README.md +++ b/README.md @@ -5,31 +5,21 @@ To use this general OAuth2 client-class, include it with $oauth2 = new OAuth2( $client_id, $client_secret, $redirect_uri, $auth, $token, $user, $authorization_type, $session, $verify, $grant_type, $response_type); ``` -$client_id is client id of the OAuth2 application - -$client_secret is client secret of the OAuth2 application - -$redirect_uri is the specified redirect-uri for the OAuth2 application - -$auth is the full url for authorization - -$token is the full token url - -$user is the full identity url (example: https://auth.dataporten.no/userinfo) +```$client_id``` is client id of the OAuth2 application +```$client_secret``` is client secret of the OAuth2 application +```$redirect_uri``` is the specified redirect-uri for the OAuth2 application +```$auth``` is the full url for authorization +```$token``` is the full token url +```$user``` is the full identity url (example: https://auth.dataporten.no/userinfo) Optional - -$authorization_type defaults to Bearer - -$session specifies whether the state is to be saved in _SESSION storage, defaults to false - -$verify is whether to verify SSL of host and peer, defaults to false - -$grant_type defaults to 'authorization_code' - -$response_type defaults to 'code' - +```$authorization_type``` defaults to Bearer +```$session``` specifies whether the state is to be saved in _SESSION storage, defaults to false +```$verify``` is whether to verify SSL of host and peer, defaults to false +```$grant_type``` defaults to 'authorization_code' +```$response_type``` defaults to 'code' To start the redirect phase