Merge pull request #362 from maekawataiki/doc

Doc Update

Author: maekawataiki

Documentation/ClientDeveloperDocumentation.md

@@ -4,21 +4,21 @@
 
 - [Instruction for an AWS Amplify client](#instruction-for-an-aws-amplify-client)
 - [Instruction for any other client (not using AWS Amplify)](#instruction-for-any-other-client-not-using-aws-amplify)
-  - [Choose your flow (Implicit, PKCE)](#choose-your-flow-implicit-pkce)
-    - [Implicit flow](#implicit-flow)
-    - [PKCE flow](#pkce-flow)
-  - [How to create a login button/link](#how-to-create-a-login-buttonlink)
-  - [How to redirect from authenticated page when no JWT token provided](#how-to-redirect-from-authenticated-page-when-no-jwt-token-provided)
-  - [How to create a logout link](#how-to-create-a-logout-link)
-  - [How to create a switch user](#how-to-create-a-switch-user)
-  - [How to create a signup link](#how-to-create-a-signup-link)
-  - [How to direct to the account settings page](#how-to-direct-to-the-account-settings-page)
-  - [How to direct to the account security settings page](#how-to-direct-to-the-account-security-settings-page)
-  - [How to direct to the SSO dashboard](#how-to-direct-to-the-sso-dashboard)
-  - [How to verify a JWT token](#how-to-verify-a-jwt-token)
-  - [How to refresh the tokens](#how-to-refresh-the-tokens)
-  - [Migration instructions](#migration-instructions)
-  - [If you use a standard OIDC client](#if-you-use-a-standard-oidc-client)
+	- [Choose your flow (Implicit, PKCE)](#choose-your-flow-implicit-pkce)
+		- [Implicit flow](#implicit-flow)
+		- [PKCE flow](#pkce-flow)
+	- [How to create a login button/link](#how-to-create-a-login-buttonlink)
+	- [How to redirect from authenticated page when no JWT token provided](#how-to-redirect-from-authenticated-page-when-no-jwt-token-provided)
+	- [How to create a logout link](#how-to-create-a-logout-link)
+	- [How to create a switch user](#how-to-create-a-switch-user)
+	- [How to create a signup link](#how-to-create-a-signup-link)
+	- [How to direct to the account settings page](#how-to-direct-to-the-account-settings-page)
+	- [How to direct to the account security settings page](#how-to-direct-to-the-account-security-settings-page)
+	- [How to direct to the SSO dashboard](#how-to-direct-to-the-sso-dashboard)
+	- [How to verify a JWT token](#how-to-verify-a-jwt-token)
+	- [How to refresh the tokens](#how-to-refresh-the-tokens)
+	- [Migration instructions](#migration-instructions)
+	- [If you use a standard OIDC client](#if-you-use-a-standard-oidc-client)
 
 This document explains how to use the broker as a login solution for your websites and mobile application.
 
@@ -35,7 +35,7 @@ Here is an example of configuration:
 import { Auth } from "aws-amplify";
 
 Auth.configure({
-  userPoolId: "us-west-2_XXXXXXXXX",               // This won't be used, but needs to match Cognito User Pool ID format
+  userPoolId: "us-west-2_XXXXXXXXX",               // This won't be used, but needs to match Cognito User Pool ID format with specified region
   userPoolWebClientId: "<your-app-client-id>",
   oauth: {
     domain: "<your-broker-domain>",                // do not include https://

README.md

@@ -2,10 +2,10 @@
 
 - [Live demo](#live-demo)
 - [Documentation](#documentation)
-  - [User Documentation](#user-documentation)
-  - [Client Developer Documentation](#client-developer-documentation)
-  - [Developer Documentation](#developer-documentation)
-  - [Comparison with the Amazon Cognito Hosted UI](#comparison-with-the-amazon-cognito-hosted-ui)
+	- [User Documentation](#user-documentation)
+	- [Client Developer Documentation](#client-developer-documentation)
+	- [Developer Documentation](#developer-documentation)
+	- [Comparison with the Amazon Cognito Hosted UI](#comparison-with-the-amazon-cognito-hosted-ui)
 - [Architecture](#architecture)
 - [Contributing](#contributing)
 - [Security](#security)
@@ -32,12 +32,28 @@ __Current features are:__
 * Migration helper (transparent migration from an existing user base to this project)
 * account setting page with various customer attributes
 * SSO dashboard (listing apps)
-* consent approbation
+* consent approbationo
 
 This is a simplified view of the scope of the project (what this repository is about):
 
 ![Projet Scope Image](Documentation/Images/SimplifiedProjectScope.png "Simplified Project Scope")
 
+## Live demo
+
+You can sign-up, sign-in, try SSO from any of these two client application demos:
+
+* Website 1 : https://main.d3865c3iw67420.amplifyapp.com _(this could be __myapp1.yourcompany.com__)_
+* Website 2 : https://main.dannbzwwbj1rp.amplifyapp.com _(this could be __www.yoursubsidiary.com__ or __myapp2.yourcompany.com__)_
+
+In a real use case, your user will only go to the broker from a client website or app, but for reference the Broker demo url itself is:
+
+* https://master.d2i2y50c8btsz.amplifyapp.com _(this could be __login.yourcompany.com__)_
+
+> __Demo Credentials__
+> For the main app you can sign-up to create your own account (_we don't use emails and phone numbers for anything else than the demo_)
+
+See [client demo code repository](https://github.com/awslabs/aws-amplify-identity-broker-client)
+
 ## Documentation
 
 ### User Documentation
@@ -53,7 +69,7 @@ This is a simplified view of the scope of the project (what this repository is a
 
 <details>
   <summary>Click to expand!</summary>
-  
+
   This project is similar to the [Amazon Cognito hosted UI](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) by many aspects. Here is the list of similarities and differences.
 
   __Similarities__
@@ -89,7 +105,7 @@ The project architecture is the following:
 
 ![Projet Architecture Image](Documentation/Images/DeployedArchitecture.png "Projet Architecture")
 
-See __[Developer Documentation](Documentation/DeveloperDocumentation.md)__ to see more detailed information on every component. 
+See __[Developer Documentation](Documentation/DeveloperDocumentation.md)__ to see more detailed information on every component.
 
 ## Contributing