Skip to content

Commit b20bca6

Browse files
committed
Edit section in README about named pipes
1 parent d4dea45 commit b20bca6

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,29 +95,29 @@ Some features are only enabled based on the connection method used.
9595
> All connection methods are available in all OSes supported by PowerShell
9696
> unless otherwise noted.
9797
98-
### Named Pipes / Unix Domain Sockets
98+
### Named Pipes
9999

100-
If you're looking for a more feature-rich experience,
101-
named pipes (AKA sockets) are the way to go.
102-
They give you all the benefits of the Language Server Protocol with extra capabilities that you can take advantage of:
100+
Named pipes enable all additional LSP capabilities, including:
103101

104-
- The PowerShell Extension Terminal
105-
- Debugging using the [Debug Adapter Protocol][debug-adapter-protocol]
102+
- the PowerShell Extension Terminal, and
103+
- debugging using the [Debug Adapter Protocol][Debug Adapter Protocol]
106104

107-
[debug-adapter-protocol]: https://microsoft.github.io/debug-adapter-protocol/
105+
[Debug Adapter Protocol]: https://microsoft.github.io/debug-adapter-protocol/
108106

109-
The typical command to start PowerShell Editor Services using named pipes / sockets is as follows:
107+
To start PSES using named pipes, use a command like:
110108

111109
```powershell
112110
pwsh -NoLogo -NoProfile -Command "./PowerShellEditorServices/Start-EditorServices.ps1 -SessionDetailsPath ./session.json"
113111
```
114112

115-
The start script, `Start-EditorServices.ps1`, is found in the `PowerShellEditorServices` folder instead the `PowerShellEditorServices.zip` downloaded from the GitHub releases.
113+
The script **Start-EditorServices.ps1** is located inside the
114+
**PowerShellEditorServices** directory. See [Manual Installation](#manual-installation).
116115

117-
The session details (which named pipes were created) will be written to the given session details path,
118-
and the client needs to point to these in order to connect.
116+
The file path given to `-SessionDetailsPath` will contain information about the
117+
created named pipes that the client needs to connect to PSES.
119118

120-
The Visual Studio Code, Vim, Neovim, and IntelliJ extensions use named pipes.
119+
Named pipes are used in the extensions for Visual Studio Code, Vim, Neovim,
120+
and IntelliJ.
121121

122122
### Standard Input and Output
123123

0 commit comments

Comments
 (0)