Skip to content

Commit 5a2bb29

Browse files
authored
Initial readme updates (#1)
1 parent 758a3e4 commit 5a2bb29

File tree

4 files changed

+16
-55
lines changed

4 files changed

+16
-55
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ IF SUFFICIENT INFORMATION IS NOT PROVIDED VIA THE FOLLOWING TEMPLATE THE ISSUE M
2222
>
2323
2424
### OS and Version?
25-
> Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)
25+
> Windows 8, 10, or 11. Linux (which distribution). macOS (Mojave? Catalina? Big Sur? Monterey?)
2626
2727
### Versions
2828
>

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## [project-title] Changelog
1+
# Microsoft identity platform product documentation backing code changelog
22

33
<a name="x.y.z"></a>
44
# x.y.z (yyyy-mm-dd)

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to [project-title]
1+
# Contributing to Microsoft identity platform product documentation backing code
22

33
This project welcomes contributions and suggestions. Most contributions require you to agree to a
44
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
@@ -51,12 +51,12 @@ chances of your issue being dealt with quickly:
5151
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
5252
causing the problem (line of code or commit)
5353

54-
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
54+
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/Azure-Samples/ms-identity-docs-code-javascript/issues/new].
5555

5656
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
5757
Before you submit your Pull Request (PR) consider the following guidelines:
5858

59-
* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
59+
* Search the repository (https://github.com/Azure-Samples/ms-identity-docs-code-javascript/pulls) for an open or closed PR
6060
that relates to your submission. You don't want to duplicate effort.
6161

6262
* Make your changes in a new git fork:

README.md

Lines changed: 11 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,18 @@
1-
# Project Name
1+
# Microsoft identity platform product documentation backing code
22

3-
(short, 1-3 sentenced, description of the project)
3+
This repo contains code used to directly support the product documentation for the [Microsoft identity platform](https://docs.microsoft.com/azure/active-directory/develop/). It is a mono-repo that contains all of the referenced tutorials relating to JavaScript-based implementations using the [Microsoft Autentication Library for JavaScript](https://github.com/AzureAD/microsoft-authentication-library-for-js).
44

5-
## Features
5+
## Content
66

7-
This project framework provides the following features:
7+
This repo contains the following code to directly support the product docs:
88

9-
* Feature 1
10-
* Feature 2
11-
* ...
12-
13-
## Getting Started
14-
15-
### Prerequisites
16-
17-
(ideally very short, if any)
18-
19-
- OS
20-
- Library version
21-
- ...
22-
23-
### Installation
24-
25-
(ideally very short)
26-
27-
- npm install [package name]
28-
- mvn install
29-
- ...
30-
31-
### Quickstart
32-
(Add steps to get up and running quickly)
33-
34-
1. git clone [repository clone url]
35-
2. cd [respository name]
36-
3. ...
37-
38-
39-
## Demo
40-
41-
A demo app is included to show how to use the project.
42-
43-
To run the demo, follow these steps:
44-
45-
(Add steps to start up the demo)
46-
47-
1.
48-
2.
49-
3.
9+
* Coming Soon!
5010

5111
## Resources
5212

53-
(Any additional resources or related projects)
54-
55-
- Link to supporting information
56-
- Link to similar sample
57-
- ...
13+
- [Microsoft identity platform product documentation](https://docs.microsoft.com/azure/active-directory/develop/)
14+
- [Microsoft Authentication Library (MSAL) documentation](https://docs.microsoft.com/azure/active-directory/develop/msal-overview)
15+
- [Microsoft Authentication Library for JavaScript (MSAL.js) 2.0 for Browser-Based Single-Page Applications](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-browser)
16+
- [Microsoft Authentication Library for Node (msal-node)](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-node)
17+
- [Microsoft Authentication Library for Angular](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-angular)
18+
- [Microsoft Authentication Library for React (msal-react)](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-react)

0 commit comments

Comments
 (0)