From 6be8bee3b182731e946545f86a81b7f1962b581e Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 30 Oct 2021 14:17:17 -0400 Subject: [PATCH] Updated readme.json --- samples/js-display-list/README.md | 34 ++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/samples/js-display-list/README.md b/samples/js-display-list/README.md index ea683c018..3d1e3f163 100644 --- a/samples/js-display-list/README.md +++ b/samples/js-display-list/README.md @@ -21,9 +21,14 @@ This simplistic sample web part demonstrates the use of JavaScript in a SharePoi > Does only show data when hosted in SharePoint. No mock data at this point for local testing the rendering. -## Used SharePoint Framework Version -![SPFx 1.11.0](https://img.shields.io/badge/drop-1.11.0-green.svg) +## Compatibility + +![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) +![Node.js LTS 10.x](https://img.shields.io/badge/Node.js-LTS%2010.x-green.svg) +![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) +![Teams N/A: Untested with Microsoft Teams](https://img.shields.io/badge/Teams-N%2FA-lightgrey.svg "Untested with Microsoft Teams") ![Local Workbench (Partially)](https://img.shields.io/badge/Local%20Workbench-Partially-yellow.svg "Only basic functionality works on local workbench") ![Hosted Workbench](https://img.shields.io/badge/Hosted%20Workbench-Fully-green.svg "Hosted workbench fully supported") + ## Applies to @@ -49,13 +54,6 @@ Version|Date|Comments 1.1|May 15, 2017|Updated to GA Version 2.0|August 29, 2020|Upgraded to SPFx 1.11.0 - -## 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 @@ -63,7 +61,7 @@ Version|Date|Comments - `npm install` - `tsd install` - `gulp serve` - - `Open the *workbench* on your Office 365 Developer tenant` + - Open the *workbench* on your Office 365 Developer tenant - Basic functionality can be tested locally, data is only shown when used in context of SharePoint ## Features @@ -77,4 +75,20 @@ This Web Part illustrates the following concepts on top of the SharePoint Framew * Logging * Rendering error messages. + +## 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.** + +## Help + +We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues. + +If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml&sample=js-display-list&authors=@VelinGeorgiev%20@sharepointknight&title=js-display-list%20-%20). + +For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=question.yml&sample=js-display-list&authors=@VelinGeorgiev%20@sharepointknight&title=js-display-list%20-%20). + +Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=suggestion.yml&sample=js-display-list&authors=@VelinGeorgiev%20@sharepointknight&title=js-display-list%20-%20). + +