Updated README

This commit is contained in:
Zach 2019-09-13 16:15:35 -04:00
parent b714cb14c6
commit 873b74da63
2 changed files with 46 additions and 19 deletions

View File

@ -1,26 +1,53 @@
## react-my-groups
# react-my-groups
This is where you include your WebPart documentation.
## Summary
### Building the code
Using Microsoft Graph this webpart grabs the Office 365 groups and links to the SharePoint sites and outputs them to a list.
```bash
git clone the repo
npm i
npm i -g gulp
gulp
```
![Demo](./assets/example.png)
This package produces the following:
## Used SharePoint Framework Version
* lib/* - intermediate-stage commonjs build artifacts
* dist/* - the bundled script, along with other resources
* deploy/* - all resources which should be uploaded to a CDN.
![drop](https://img.shields.io/badge/drop-1.9.1-green.svg)
### Build options
## Applies to
gulp clean - TODO
gulp test - TODO
gulp serve - TODO
gulp bundle - TODO
gulp package-solution - TODO
* [SharePoint Framework](https:/dev.office.com/sharepoint)
## Prerequisites
> Any special pre-requisites?
## Solution
Solution|Author(s)
--------|---------
react-my-groups | Zach Roberts
## Version history
Version|Date|Comments
-------|----|--------
1.0|September 13, 2019|Initial release
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
---
## Minimal Path to Awesome
* Clone this repository
* in the command line run:
* `npm install`
* `gulp serve --nobrowser`
Browse to SharePoint Online workbench (https://tenant.sharepoint.com/_layouts/15/workbench.aspx)
## Features
This web part lists the current user's Office 365 groups with links to the groups SharePoint site.
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-my-groups" />

BIN
assets/example.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB