Skip to content
This repository was archived by the owner on May 18, 2024. It is now read-only.

Commit 90d0a71

Browse files
authored
Update README.md (#62)
* Update README.md * Updates Readme
1 parent e472c7e commit 90d0a71

13 files changed

+50
-28
lines changed

README.md

Lines changed: 50 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,63 +13,66 @@
1313
alt="installs" />
1414
</a>
1515
</p>
16-
This extension provides functionalities that may be helpful when creating scripts using PnP PowerShell. Currently, the extension provides:
1716

18-
- docs viewer inside VS Code
19-
- samples gallery
20-
- snippets with all possible commands
17+
This extension will boost your productivity when creating scripts that use PnP PowerShell. Currently, the extension provides:
18+
19+
- embedded documentation
20+
- samples powered by PnP Script Sample Gallery
21+
- snippets with all possible PnP PowerShell commands
2122

2223
Please check [PnP PowerShell docs](https://pnp.github.io/powershell/) for more information.
2324

24-
## ✨ Features
25+
![samples](./assets/images/main.png)
26+
27+
## ✨ Capabilities
2528

26-
### Script samples gallery
29+
### 1️⃣ Script samples gallery
2730

28-
Using `PnP PS: Open samples gallery` command, or 'Samples' button from the controls above the command list, you may open the gallery with all available samples. Currently, the samples shown are retrieved from the [PnP script samples repository](https://github.com/pnp/script-samples). From the samples gallery you may go to the sample location or create a new tab (file) in the editor prefilled with the PnP PowerShell script. It is possible to search for samples by:
31+
Using `PnP PS: Open samples gallery` command, or the 'Samples' button from the controls above the command list, you may open the gallery with all available script samples. Currently, the samples shown are retrieved from the [PnP script samples repository](https://github.com/pnp/script-samples). From the samples gallery you may go to the sample location or create a new tab (file) in the editor prefilled with the PnP PowerShell script. It is possible to search for samples by:
2932

3033
- title
3134
- authors
3235
- commands used in samples
3336

34-
![samples](/assets/images/samplesCommand.gif)
37+
![samples](./assets/images/samplesCommand.gif)
3538

36-
### Docs
39+
### 2️⃣ Docs
3740

38-
This functionality provides PnP PowerShell docs view for all commands inside VS Code. No more transition between the code editor and browser is needed. It is possible to go to docs original website location and also open sample gallery showing all samples using that command.
41+
This functionality provides PnP PowerShell docs view for all commands inside VS Code. No more context switching between the code editor and browser. It is possible to go to docs original website location and also open the sample gallery showing all samples using that command.
3942

40-
![docs](/assets/images/howDocsWork.gif)
43+
![docs](./assets/images/howDocsWork.gif)
4144

42-
It is also possible to use the command `PnP PS: Open docs for command` to open the docs for a specific command. When that part of the script text is selected the command is prefilled with the PnP PowerShell command name.
45+
It is also possible to use the command `PnP PS: Open docs for command` to open the docs for a specific command.
4346

44-
![docs](/assets/images/docsCommand.gif)
47+
![docs](./assets/images/docsCommand.gif)
4548

46-
### Command list tree view
49+
### 3️⃣ Command list tree view
4750

48-
![docs](/assets/images/treeViewIcon.png)
51+
![docs](./assets/images/treeViewIcon.png)
4952

5053
The command list also has the functionality to group commands view by command name verb
5154

52-
![docs](/assets/images/treeView.png)
55+
![docs](./assets/images/treeView.png)
5356

54-
### Snippets
57+
### 4️⃣ Snippets
5558

56-
The extensions help to quickly find the proper PnP PowerShell command and add it to the code using snippets. The command is added to the list of obligatory parameters. It is possible to quickly move between parameters using 'Tab' key. Each snippet has a description which may be found in the docs which is a great help to quickly understand the commands functionality.
59+
The extensions help to quickly find the correct PnP PowerShell command and use it thanks to code snippets. The command is added along with all required parameters. It is possible to quickly move between parameters using 'Tab' key. Each snippet has a description which may be found in the docs which is a great help to quickly understand the commands functionality.
5760

58-
![snippetsList](/assets/images/snippets.gif)
61+
![snippetsList](./assets/images/snippets.gif)
5962

60-
In order to use snippets please type part of a PnP PowerShell command and press enter or tab. The command will be automatically added to the code with the possibility to provide obligatory parameters. You may also use 'Ctrl + Space' (Windows, Linux) or 'Cmd + Space' (macOS) to activate snippets from within the editor.
63+
In order to use snippets please type part of a PnP PowerShell command and press enter or tab. The command will be automatically added to the code along with all required parameters. You may also use 'Ctrl + Space' (Windows, Linux) or 'Cmd + Space' (macOS) to activate snippets from within the editor.
6164

62-
![snippetsList](/assets/images/snippetsList.png)
65+
![snippetsList](./assets/images/snippetsList.png)
6366

6467
It is also possible to use the command `Insert Snippet` in VS Code to see the full list
6568

66-
![snippetsList](/assets/images/listOfCommandsFromToolbar.png)
69+
![snippetsList](./assets/images/listOfCommandsFromToolbar.png)
6770

68-
### Transition to PnP PowerShell Docs website
71+
### 5️⃣ Transition to PnP PowerShell Docs website
6972

70-
The extension provides many ways to get to the PnP PowerShell Docs web page or GitHub repository.
73+
The extension provides many ways to go to the PnP PowerShell Docs web page or GitHub repository.
7174

72-
![docs](/assets/images/webPageButtons.png)
75+
![docs](./assets/images/webPageButtons.png)
7376

7477
## 🤖 Commands
7578

@@ -80,12 +83,31 @@ The extension provides the following commands:
8083
| PnP PS: Open samples gallery | Opens up the sample gallery |
8184
| PnP PS: Open docs for command | Search for a command doc file. The command may also be prefilled by the selected PnP PowerShell command |
8285

83-
![commands](/assets/images/commands.png)
86+
![commands](./assets/images/commands.png)
87+
88+
## 🙋 Support
89+
90+
This project is a community lead extension provided by the [Microsoft 365 and Power Platform Community](https://aka.ms/m365/community) members. Questions, problems, or feedback is more than welcome. Please create an issue in the extension repository [issue list](https://github.com/Adam-it/pnp-powershell-extension/issues).
91+
92+
## 👍 Community
93+
94+
Are you building experiences for Microsoft 365? - Everyone is welcome to join our [Microsoft 365 and Power Platform Community](https://aka.ms/m365/community) efforts with community calls, samples and guidance. Join our [weekly community calls](https://aka.ms/m365/calls) for Microsoft 365 and Power Platform topics or engage with us on [Discord](https://aka.ms/community/discord). Everyone is welcome 🧡
8495

85-
## 💬 Feedback
96+
## 🧾 Code of Conduct
8697

87-
Any questions, problems, or feedback is more than welcome. Please create an issue in the extension repository [issue list](https://github.com/Adam-it/pnp-powershell-extension/issues).
98+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
99+
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
100+
101+
## 😍 "Sharing is Caring"
102+
103+
<h1 align="center">
104+
<img alt="Microsoft 365 & Power Platform Community" src="./assets/images/parker-pnp.png" width="200px" />
105+
</h1>
88106

89107
## 🔑 License
90108

91109
[MIT License](https://github.com/Adam-it/pnp-powershell-extension/blob/main/LICENSE.md)
110+
111+
## ⚠️ Disclaimer
112+
113+
**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.**

assets/images/commands.png

7.06 KB
Loading

assets/images/docsCommand.gif

2.91 MB
Loading

assets/images/howDocsWork.gif

-410 KB
Loading
3.8 KB
Loading

assets/images/main.png

665 KB
Loading

assets/images/parker-pnp.png

53 KB
Loading

assets/images/samplesCommand.gif

-523 KB
Loading

assets/images/snippets.gif

845 KB
Loading

assets/images/snippetsList.png

-7.17 KB
Loading

assets/images/treeView.png

40.9 KB
Loading

assets/images/treeViewIcon.png

26 KB
Loading

assets/images/webPageButtons.png

369 KB
Loading

0 commit comments

Comments
 (0)