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

Commit

Permalink
Updates Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam-it committed May 18, 2024
1 parent fa00985 commit 6f46100
Show file tree
Hide file tree
Showing 13 changed files with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ This extension will boost your productivity when creating scripts that use PnP P

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

![samples](./assets/images/main.png)

## ✨ Capabilities

### 1️⃣ Script samples gallery
Expand All @@ -32,45 +34,45 @@ Using `PnP PS: Open samples gallery` command, or the 'Samples' button from the c
- authors
- commands used in samples

![samples](/assets/images/samplesCommand.gif)
![samples](./assets/images/samplesCommand.gif)

### 2️⃣ Docs

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.

![docs](/assets/images/docsCommand.gif)
![docs](./assets/images/docsCommand.gif)

### 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)

### 4️⃣ Snippets

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 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)

### 5️⃣ Transition to PnP PowerShell Docs website

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

Expand All @@ -81,7 +83,7 @@ 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

Expand All @@ -96,6 +98,12 @@ Are you building experiences for Microsoft 365? - Everyone is welcome to join ou
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 [[email protected]](mailto:[email protected]) with any additional questions or comments.

## 😍 "Sharing is Caring"

<h1 align="center">
<img alt="Microsoft 365 & Power Platform Community" src="./assets/images/parker-pnp.png" width="200px" />
</h1>

## 🔑 License

[MIT License](https://github.com/Adam-it/pnp-powershell-extension/blob/main/LICENSE.md)
Expand Down
Binary file modified assets/images/commands.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/docsCommand.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/howDocsWork.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/listOfCommandsFromToolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/parker-pnp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/samplesCommand.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/snippets.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/snippetsList.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/treeView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/treeViewIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/webPageButtons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6f46100

Please sign in to comment.