Update README-template.md

This commit is contained in:
Hugo Bernier 2020-11-08 22:53:29 -05:00 committed by GitHub
parent 647a830865
commit 519a7ed730
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions

View File

@ -1,6 +1,7 @@
# title of the sample
# Title of the sample
> When naming your sample, try to give it a friendly name that describes what it does. Avoid using terms like SharePoint and Web Part -- because that's what all the samples in this repo is all about. Also, don't use React, JavaScript, etc. in your sample title -- unless that's what the sample is about.
> This is how you want the sample to appear in the samples browser.
> When naming your sample, try to give it a friendly name that describes what it does. Avoid using terms like `SharePoint` and `WebPart` -- because that's what all the samples in this repo is all about. Also, don't use `React`, `Angular`, `JavaScript`, etc. in your sample title -- unless that's what the sample is about.
## Summary
@ -8,11 +9,10 @@ Short summary on functionality and used technologies.
> Please provide a high-quality screenshot of your web parts below. It should be stored in a folder called `assets`.
> If possible, use a resolution of 1920x1080.
> If your web part uses a placeholder screen and requires the user to configure it, please use a screenshot of the web part as it appears after it has been configured.
> If your web part uses a placeholder screen and requires the user to configure it, please use a screenshot of the web part as it appears **after** it has been configured.
> You can add as many screen shots as you'd like to help users understand your web part without having to download it and install it.
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
![picture of the web part in action](assets/preview.png)
## Used SharePoint Framework Version