Skip to content

Commit f8ebaf8

Browse files
committed
cleaned up READMEs
1 parent fb0b884 commit f8ebaf8

File tree

4 files changed

+2659
-2541
lines changed

4 files changed

+2659
-2541
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,27 @@ The React AAD MSAL library provides the following features:
1717
- create your own function to handle how logout (using this AzureAD component) is triggered in your react app
1818
* Optional use of redux store containing the token and user information returned from Active Directory
1919

20-
## Getting Started //TODO
20+
## Getting Started
2121

2222
### Prerequisites
2323

24-
(ideally very short, if any)
25-
26-
- OS
27-
- Library version
28-
- ...
24+
- [node.js](https://nodejs.org/en/)
2925

3026
### Installation
3127

32-
(ideally very short)
33-
34-
- npm install [package name]
35-
- mvn install
36-
- ...
28+
- `npm install react-aad-msal`
3729

3830
### Quickstart
39-
(Add steps to get up and running quickly)
4031

41-
1. git clone [repository clone url]
42-
2. cd [respository name]
43-
3. ...
32+
If you'd like a sample application running, please see the [sample readme](sample/README.md).
33+
34+
To build this component, follow these steps:
35+
36+
1. `git clone https://github.com/Azure-Samples/react-aad-msal.git`
37+
2. `cd ./react-aad-msal`
38+
3. Build the `react-aad-msal` component:
39+
- `npm install`
40+
- `npm run build`
4441

4542
## Setup
4643
In the render module of your component, make sure to create an AzureAD component with the arguments you need. This uses the functions that you will define. Once the user is successfully authenticated, the component will render the JSX returned by the `authenticatedFunction`, which in this case is called `logoutCallback`. This is where you should put the secure, user-specific parts of your app. `loginCallback` and `printUserInfo` can be any user defined functions.
@@ -53,7 +50,7 @@ Find the assignment for ClientID and replace the value with the Application ID f
5350
return (
5451
<AzureAD
5552
clientID={'<Application ID for your application>'}
56-
scopes={['https://<your-tenant-name>.onmicrosoft.com/<your-application-name>/<scope (i.e. demo.read)>']}
53+
scopes={['<property (i.e. user.read)>', 'https://<your-tenant-name>.onmicrosoft.com/<your-application-name>/<scope (i.e. demo.read)>']}
5754
unauthenticatedFunction={this.loginCallback}
5855
authenticatedFunction={this.logoutCallback}
5956
userInfoCallback={this.printUserInfo}
@@ -164,4 +161,8 @@ A sample React-based Single Page Application (SPA) that uses this component is a
164161
- [Get Started with Azure Active Directory](https://docs.microsoft.com/en-us/azure/active-directory/get-started-azure-ad)
165162
- [MSAL Documentation](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AzureAD/microsoft-authentication-library-for-js/dev/docs/index.html)
166163
- [AAD v2 Scopes](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-scopes)
167-
- [AAD B22 Setup MSA App](https://docs.microsoft.com/en-us/azure/active-directory-b2c/active-directory-b2c-setup-msa-app)
164+
- [AAD B22 Setup MSA App](https://docs.microsoft.com/en-us/azure/active-directory-b2c/active-directory-b2c-setup-msa-app)
165+
166+
## Problems or Suggestions
167+
168+
[Please create an issue.](/issues)

0 commit comments

Comments
 (0)