Skip to content

Commit 40cda91

Browse files
committed
Add API and host process usage documentation
This change introduces new documentation that explains the usage of both the .NET API and the host process.
1 parent f25b129 commit 40cda91

File tree

3 files changed

+1135
-2
lines changed

3 files changed

+1135
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,24 @@ across multiple editors.
1010

1111
- The Language Service provides code navigation actions (find references, go to definition) and statement completions (IntelliSense)
1212
- The Analysis Service integrates PowerShell Script Analyzer to provide real-time semantic analysis of scripts
13-
- The Console Service provides a simplified PowerShell host for an interactive console (REPL)
14-
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, locals, etc) - COMING SOON
13+
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
1514

1615
The core Editor Services library is intended to be consumed in any type of host application, whether
1716
it is a WPF UI, console application, or web service. A standard console application host is included
1817
so that you can easily consume Editor Services functionality in any editor using either the included
1918
standard input/output transport protocol or a transport of your own design.
2019

20+
## Documentation
21+
22+
Check out the following two pages for information about how to use the API and host process:
23+
24+
- **[Using the .NET API](docs/using_the_dotnet_api.md)** - Read this if you want to use the API in your .NET application
25+
- **[Using the Host Process](docs/using_the_host_process.md)** - Read this if you want to use the API in a non-.NET application such as a code editor
26+
27+
## Installation
28+
29+
**TODO**: Add information about acquiring packages from NuGet.
30+
2131
## Cloning the Code
2232

2333
To clone the repository and initialize all the submodules at once you can run:

docs/using_the_dotnet_api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Using the PowerShell Editor Services .NET API
2+
3+
**TODO:** Provide conceptual overview and code examples.

0 commit comments

Comments
 (0)