Skip to content

Commit c32d50f

Browse files
authored
Merge branch 'PowerShell:master' into master
2 parents 389f046 + 97a663f commit c32d50f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ The functionality in PowerShell Editor Services is already available in the foll
2323
- Code navigation actions (find references, go to definition)
2424
- Statement completions (IntelliSense)
2525
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
26-
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
26+
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc.)
2727
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
2828
- A full, terminal-based Integrated Console experience for interactive development and debugging
2929

3030
## Usage
3131

32-
Looking to integrate PowerShell Editor Services into your [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) compliant editor or client? We support two ways of connecting.
32+
If you're looking to integrate PowerShell Editor Services into your [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) compliant editor or client, we support two ways of connecting.
3333

3434
### Named Pipes/Unix Domain Sockets (recommended)
3535

36-
If you're looking for the more feature-rich experience,
36+
If you're looking for a more feature-rich experience,
3737
Named Pipes are the way to go.
38-
They give you all the benefit of the Language Server Protocol with extra capabilities that you can take advantage of:
38+
They give you all the benefits of the Language Server Protocol with extra capabilities that you can take advantage of:
3939

4040
- The PowerShell Integrated Console
4141
- Debugging using the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/)
@@ -55,7 +55,7 @@ Once the command is run,
5555
PowerShell Editor Services will wait until the client connects to the Named Pipe.
5656
The `session.json` will contain the paths of the Named Pipes that you will connect to.
5757
There will be one you immediately connect to for Language Server Protocol messages,
58-
and one you connect to when you launch the debugger for Debug Adapter Protocol messages.
58+
and once you connect to when you launch the debugger for Debug Adapter Protocol messages.
5959

6060
The Visual Studio Code, Vim, and IntelliJ extensions currently use Named Pipes.
6161

@@ -68,7 +68,7 @@ The PowerShell Integrated Console uses the host process' Stdio streams for conso
6868
If you want to take advantage of the PowerShell Integrated Console which automatically shares state with the editor-side,
6969
you must include the `-EnableConsoleRepl` switch when called `Start-EditorServices.ps1`.
7070

71-
This is typically used if your client has the ability to create arbitrary terminals in the editor like below:
71+
This is typically used if your client can create arbitrary terminals in the editor like below:
7272

7373
![integrated console in vscode](https://user-images.githubusercontent.com/2644648/66245018-04ca8000-e6c0-11e9-808c-b86144149444.png)
7474

@@ -83,13 +83,13 @@ If you want to take advantage of debugging,
8383
your client must support the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/).
8484
Your client should use the path to the debug named pipe found in the `session.json` file talked about above.
8585

86-
Currently only the Visual Studio Code extension supports debugging.
86+
Currently, only the Visual Studio Code extension supports debugging.
8787

8888
### Stdio
8989

90-
Stdio is a simpler and more universal mechanism when it comes to the Language Server Protocol and is what we recommend if your editor/client doesn't need to support the PowerShell Integrated Console or debugging.
90+
Stdio is a simpler and more universal mechanism for the Language Server Protocol. We recommend using it if your editor/client doesn't need to support the PowerShell Integrated Console or debugging.
9191

92-
> NOTE: Debugging and the Integrated Console are not features of the Stdio channel because each feature requires their own IO streams and since the Stdio model only provides a single set of streams (Stdio),
92+
> NOTE: Debugging and the Integrated Console are not features of the Stdio channel because each feature requires its own IO streams and since the Stdio model only provides a single set of streams (Stdio),
9393
> these features cannot be leveraged.
9494
9595
The typical command to start PowerShell Editor Services using stdio is as follows:
@@ -115,7 +115,7 @@ Please note that we only consider the following as stable APIs that can be relie
115115
- Debug adapter protocol connection
116116
- Start up mechanism
117117

118-
The types of PowerShell Editor Services can change at any moment and should not be linked against in production environment.
118+
The types of PowerShell Editor Services can change at any moment and should not be linked against in a production environment.
119119

120120
## Development
121121

@@ -168,7 +168,7 @@ This project is [licensed under the MIT License](LICENSE).
168168
## [Code of Conduct][conduct-md]
169169

170170
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
171-
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
171+
For more information, see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
172172

173173
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
174174
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/

0 commit comments

Comments
 (0)