Skip to content

Commit 9257cfa

Browse files
elisenyangElise Yang
andauthored
Update readme (#654)
* edit readme * edits * edits Co-authored-by: Elise Yang <[email protected]>
1 parent 24dbe3c commit 9257cfa

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

readme.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
1-
# Microsoft Graph Toolkit
1+
<h1 align="center">
2+
<img height="120" src="https://github.com/microsoftgraph/microsoft-graph-toolkit/raw/main/assets/graff.png" title="Graff the Giraffe">
3+
<br>
4+
Microsoft Graph Toolkit
5+
</h1>
26

3-
<img align="left" height="150" src="https://github.com/microsoftgraph/microsoft-graph-toolkit/raw/main/assets/graff.png" title="Graff the Giraffe">
7+
<h4 align="center">Web Components powered by <a href="https://graph.microsoft.com">Microsoft Graph</a></h4>
48

5-
[![NPM](https://img.shields.io/npm/v/@microsoft/mgt.svg)](https://www.npmjs.com/package/@microsoft/mgt) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/microsoftgraph/msgraph-sdk-javascript) [![stackoverflow](https://img.shields.io/stackexchange/stackoverflow/t/microsoft-graph-toolkit.svg)](https://stackoverflow.com/questions/tagged/microsoft-graph-toolkit)
6-
[![Build Status](https://dev.azure.com/microsoft-graph-toolkit/microsoft-graph-toolkit/_apis/build/status/microsoftgraph.microsoft-graph-toolkit?branchName=main)](https://dev.azure.com/microsoft-graph-toolkit/microsoft-graph-toolkit/_build/latest?definitionId=1&branchName=main) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/@microsoft/mgt) [![Storybook](https://raw.githubusercontent.com/storybooks/brand/main/badge/badge-storybook.svg?sanitize=true)](https://mgt.dev)
9+
<p align="center">
10+
<a href="https://www.npmjs.com/package/@microsoft/mgt"><img src="https://img.shields.io/npm/v/@microsoft/mgt.svg"></a> <a href="https://github.com/microsoftgraph/msgraph-sdk-javascript"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"></a> <a href="https://stackoverflow.com/questions/tagged/microsoft-graph-toolkit"><img src="https://img.shields.io/stackexchange/stackoverflow/t/microsoft-graph-toolkit.svg"></a>
11+
<a href="https://dev.azure.com/microsoft-graph-toolkit/microsoft-graph-toolkit/_build/latest?definitionId=1&branchName=main"><br><img src="https://dev.azure.com/microsoft-graph-toolkit/microsoft-graph-toolkit/_apis/build/status/microsoftgraph.microsoft-graph-toolkit?branchName=main"></a> <a href="https://www.webcomponents.org/element/@microsoft/mgt"><img src="https://img.shields.io/badge/webcomponents.org-published-blue.svg"></a> <a href="https://mgt.dev"><img src="https://raw.githubusercontent.com/storybooks/brand/main/badge/badge-storybook.svg?sanitize=true"></a>
12+
</p>
713

8-
The Microsoft Graph Toolkit is a collection of web components powered by the Microsoft Graph.
14+
<p align="center">
15+
The Microsoft Graph Toolkit is a collection of web components powered by Microsoft Graph. The components are functional, working automatically with Microsoft Graph, and work with any web framework and on all modern browsers.
16+
</p>
917

10-
Components are functional and work automatically with the Microsoft Graph
11-
12-
Components work with any web framework and on all modern browsers. IE 11 is also supported
13-
14-
[Here is a quick jsfiddle](https://jsfiddle.net/metulev/9phqxLd5/)
18+
<p align="center">
19+
<a href="#components-&-documentation">Components & Documentation</a> • <a href="#getting-started">Getting Started</a> • <a href="#running-the-samples">Running the Samples</a> • <a href="#contribute">Contribute</a> • <a href="#feedback-and-requests">Feedback & Requests</a> <br>• <a href="#license">License</a> • <a href="#code-of-conduct">Code of Conduct</a>
20+
</p>
1521

1622
## Components & Documentation
1723

18-
The toolkit currently includes the following components:
24+
You can explore components and samples with the [playground](https://mgt.dev) powered by storybook.
25+
26+
The Toolkit currently includes the following components:
1927

2028
* [mgt-login](https://docs.microsoft.com/graph/toolkit/components/login)
2129
* [mgt-person](https://docs.microsoft.com/graph/toolkit/components/person)
@@ -27,21 +35,26 @@ The toolkit currently includes the following components:
2735
* [mgt-get](https://docs.microsoft.com/graph/toolkit/components/get)
2836
* [mgt-teams-channel-picker](https://docs.microsoft.com/en-us/graph/toolkit/components/teams-channel-picker)
2937

30-
And the following providers:
38+
The components work best when used with a [provider](https://docs.microsoft.com/graph/toolkit/providers). The provider handles authentication and the requests to the Microsoft Graph APIs used by the components. The Toolkit contains the following providers:
3139

3240
* [Msal Provider](https://docs.microsoft.com/graph/toolkit/providers/msal)
3341
* [SharePoint Provider](https://docs.microsoft.com/graph/toolkit/providers/sharepoint)
3442
* [Teams Provider](https://docs.microsoft.com/graph/toolkit/providers/teams)
3543
* [Proxy Provider](https://docs.microsoft.com/graph/toolkit/providers/proxy)
3644
* [Simple Provider](https://docs.microsoft.com/graph/toolkit/providers/custom)
3745

38-
[View the full documentation](https://docs.microsoft.com/graph/toolkit/overview)
46+
You can also create your own providers by extending the [IProvider](https://docs.microsoft.com/graph/toolkit/providers/custom) abstract class.
3947

40-
You can now explore components and samples with the [playground](https://mgt.dev) powered by storybook.
48+
[View the full documentation](https://docs.microsoft.com/graph/toolkit/overview)
4149

4250
## Getting Started
4351

44-
[Watch the Getting Started Video](https://www.youtube.com/watch?v=oZCGb2MMxa0)
52+
The following guides are available to help you get started with the Toolkit:
53+
* [Build a web application (vanilla JS)](https://docs.microsoft.com/graph/toolkit/get-started/build-a-web-app)
54+
* [Build a SharePoint Web Part](https://docs.microsoft.com/graph/toolkit/get-started/build-a-sharepoint-web-part)
55+
* [Build a Microsoft Teams Tab](https://docs.microsoft.com/graph/toolkit/get-started/build-a-microsoft-teams-tab)
56+
* [Use the Toolkit with React](https://docs.microsoft.com/graph/toolkit/get-started/use-toolkit-with-react)
57+
* [Use the Toolkit with Angular](https://docs.microsoft.com/graph/toolkit/get-started/use-toolkit-with-angular)
4558

4659
You can use the components by referencing the loader directly (via unpkg), or installing the npm package
4760

@@ -114,13 +127,7 @@ or, if you already use MSAL.js and have a `UserAgentApplication`, you can use it
114127
115128
Providers.globalProvider = new MsalProvider({ userAgentApplication: app });
116129
</script>
117-
```
118-
119-
## Providers
120-
121-
The components work best when used with a [provider](https://docs.microsoft.com/graph/toolkit/providers). The provider exposes authentication and Microsoft Graph apis used by the components to call into the Microsoft Graph.
122-
123-
The toolkit contains providers for [MSAL](https://docs.microsoft.com/graph/toolkit/providers/msal), [SharePoint](https://docs.microsoft.com/graph/toolkit/providers/sharepoint), and [Teams](https://docs.microsoft.com/graph/toolkit/providers/teams). You can also create your own providers by extending the [IProvider](https://docs.microsoft.com/graph/toolkit/providers/custom) abstract class.
130+
```
124131

125132
## Running the samples
126133

0 commit comments

Comments
 (0)