diff --git a/README.md b/README.md index 335eab9..7154b86 100644 --- a/README.md +++ b/README.md @@ -13,63 +13,66 @@ alt="installs" />

-This extension provides functionalities that may be helpful when creating scripts using PnP PowerShell. Currently, the extension provides: -- docs viewer inside VS Code -- samples gallery -- snippets with all possible commands +This extension will boost your productivity when creating scripts that use PnP PowerShell. Currently, the extension provides: + +- embedded documentation +- samples powered by PnP Script Sample Gallery +- snippets with all possible PnP PowerShell commands Please check [PnP PowerShell docs](https://pnp.github.io/powershell/) for more information. -## ✨ Features +![samples](./assets/images/main.png) + +## ✨ Capabilities -### Script samples gallery +### 1️⃣ Script samples gallery -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: +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: - title - authors - commands used in samples -![samples](/assets/images/samplesCommand.gif) +![samples](./assets/images/samplesCommand.gif) -### Docs +### 2️⃣ Docs -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. +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. -![docs](/assets/images/howDocsWork.gif) +![docs](./assets/images/howDocsWork.gif) -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. +It is also possible to use the command `PnP PS: Open docs for command` to open the docs for a specific command. -![docs](/assets/images/docsCommand.gif) +![docs](./assets/images/docsCommand.gif) -### Command list tree view +### 3️⃣ Command list tree view -![docs](/assets/images/treeViewIcon.png) +![docs](./assets/images/treeViewIcon.png) The command list also has the functionality to group commands view by command name verb -![docs](/assets/images/treeView.png) +![docs](./assets/images/treeView.png) -### Snippets +### 4️⃣ Snippets -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. +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. -![snippetsList](/assets/images/snippets.gif) +![snippetsList](./assets/images/snippets.gif) -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. +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. -![snippetsList](/assets/images/snippetsList.png) +![snippetsList](./assets/images/snippetsList.png) It is also possible to use the command `Insert Snippet` in VS Code to see the full list -![snippetsList](/assets/images/listOfCommandsFromToolbar.png) +![snippetsList](./assets/images/listOfCommandsFromToolbar.png) -### Transition to PnP PowerShell Docs website +### 5️⃣ Transition to PnP PowerShell Docs website -The extension provides many ways to get to the PnP PowerShell Docs web page or GitHub repository. +The extension provides many ways to go to the PnP PowerShell Docs web page or GitHub repository. -![docs](/assets/images/webPageButtons.png) +![docs](./assets/images/webPageButtons.png) ## 🤖 Commands @@ -80,12 +83,31 @@ The extension provides the following commands: | PnP PS: Open samples gallery | Opens up the sample gallery | | PnP PS: Open docs for command | Search for a command doc file. The command may also be prefilled by the selected PnP PowerShell command | -![commands](/assets/images/commands.png) +![commands](./assets/images/commands.png) + +## 🙋 Support + +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). + +## 👍 Community + +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 🧡 -## 💬 Feedback +## 🧾 Code of Conduct -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). +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +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. + +## 😍 "Sharing is Caring" + +

+ Microsoft 365 & Power Platform Community +

## 🔑 License [MIT License](https://github.com/Adam-it/pnp-powershell-extension/blob/main/LICENSE.md) + +## ⚠️ 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.** diff --git a/assets/images/commands.png b/assets/images/commands.png index 698a169..f84b1aa 100644 Binary files a/assets/images/commands.png and b/assets/images/commands.png differ diff --git a/assets/images/docsCommand.gif b/assets/images/docsCommand.gif index 6dd3919..98d824a 100644 Binary files a/assets/images/docsCommand.gif and b/assets/images/docsCommand.gif differ diff --git a/assets/images/howDocsWork.gif b/assets/images/howDocsWork.gif index 8acfd6d..b70a767 100644 Binary files a/assets/images/howDocsWork.gif and b/assets/images/howDocsWork.gif differ diff --git a/assets/images/listOfCommandsFromToolbar.png b/assets/images/listOfCommandsFromToolbar.png index 6608f1e..64dbc32 100644 Binary files a/assets/images/listOfCommandsFromToolbar.png and b/assets/images/listOfCommandsFromToolbar.png differ diff --git a/assets/images/main.png b/assets/images/main.png new file mode 100644 index 0000000..bfd5b0d Binary files /dev/null and b/assets/images/main.png differ diff --git a/assets/images/parker-pnp.png b/assets/images/parker-pnp.png new file mode 100644 index 0000000..b23c89b Binary files /dev/null and b/assets/images/parker-pnp.png differ diff --git a/assets/images/samplesCommand.gif b/assets/images/samplesCommand.gif index 54eccb0..b6296a6 100644 Binary files a/assets/images/samplesCommand.gif and b/assets/images/samplesCommand.gif differ diff --git a/assets/images/snippets.gif b/assets/images/snippets.gif index 1b0167d..bb00d9a 100644 Binary files a/assets/images/snippets.gif and b/assets/images/snippets.gif differ diff --git a/assets/images/snippetsList.png b/assets/images/snippetsList.png index dfe2de3..127eb58 100644 Binary files a/assets/images/snippetsList.png and b/assets/images/snippetsList.png differ diff --git a/assets/images/treeView.png b/assets/images/treeView.png index e6e13a7..5b909dc 100644 Binary files a/assets/images/treeView.png and b/assets/images/treeView.png differ diff --git a/assets/images/treeViewIcon.png b/assets/images/treeViewIcon.png index f3355dd..f0e516c 100644 Binary files a/assets/images/treeViewIcon.png and b/assets/images/treeViewIcon.png differ diff --git a/assets/images/webPageButtons.png b/assets/images/webPageButtons.png index 23a6bd2..314cd63 100644 Binary files a/assets/images/webPageButtons.png and b/assets/images/webPageButtons.png differ