Skip to content

Commit 087cd0b

Browse files
committed
Update readme(s)
1 parent abb468b commit 087cd0b

File tree

2 files changed

+74
-45
lines changed

2 files changed

+74
-45
lines changed

README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Discord](https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white)](https://aka.ms/powershell-vscode-discord)
77
[![Join the chat at https://gitter.im/PowerShell/vscode-powershell](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
88

9-
This extension provides rich PowerShell language support for [Visual Studio Code](https://github.com/Microsoft/vscode).
9+
This extension provides rich PowerShell language support for [Visual Studio Code](https://github.com/Microsoft/vscode) (VS Code).
1010
Now you can write and debug PowerShell scripts using the excellent IDE-like interface
1111
that Visual Studio Code provides.
1212

@@ -66,12 +66,12 @@ You can also install a VSIX package from our [Releases page](https://github.com/
6666
instructions. The easiest way is through the command line:
6767

6868
```powershell
69-
code --install-extension PowerShell-<version>.vsix
69+
code --install-extension powershell-<version>.vsix
7070
```
7171

7272
> NOTE: If you are using VS Code Insiders, the command will be `code-insiders`.
7373
74-
## Script-based Installation
74+
### Script-based Installation
7575

7676
If you're on Windows 7 or greater with the [PowerShellGet](https://msdn.microsoft.com/powershell/gallery/readme)
7777
module installed, you can easily install both Visual Studio Code and the PowerShell
@@ -99,7 +99,7 @@ If you experience any problems with the PowerShell Extension, see
9999
[the troubleshooting docs](./docs/troubleshooting.md) for information
100100
on diagnosing and reporting issues.
101101

102-
### Security Note
102+
## Security Note
103103

104104
For any security issues, please see [here](./docs/troubleshooting.md#note-on-security).
105105

@@ -113,19 +113,14 @@ how to use them.
113113
This folder can be found at the following path:
114114

115115
```powershell
116-
$HOME/.vscode[-insiders]/extensions/ms-vscode.PowerShell-<version>/examples
116+
$HOME/.vscode[-insiders]/extensions/ms-vscode.powershell[-preview]-<version>/examples
117117
```
118118

119-
or if you're using the preview version of the extension
120-
121-
```powershell
122-
$HOME/.vscode[-insiders]/extensions/ms-vscode.powershell-preview-<version>/examples
123-
```
124-
125-
To open/view the extension's examples in Visual Studio Code, run the following from your PowerShell command prompt:
119+
To open/view the extension's examples in Visual Studio Code, run the following from your
120+
PowerShell session:
126121

127122
```powershell
128-
code (Get-ChildItem $Home\.vscode\extensions\ms-vscode.PowerShell-*\examples)[-1]
123+
code (Get-ChildItem $HOME/.vscode/extensions/ms-vscode.powershell-*/examples)[-1]
129124
```
130125

131126
## Contributing to the Code
@@ -137,6 +132,13 @@ on how to contribute to this extension!
137132

138133
- [Rob Holt](https://github.com/rjmholt) - [@rjmholt](https://twitter.com/rjmholt)
139134
- [Andy Schwartzmeyer](https://github.com/andschwa) - [andschwa.com](https://andschwa.com/)
135+
- [Sydney Smith](https://github.com/SydneyhSmith) - [@SydneyhSmith](https://github.com/SydneyhSmith)
136+
137+
### Emeriti
138+
139+
- [Keith Hill](https://github.com/rkeithhill) - [@r_keith_hill](http://twitter.com/r_keith_hill)
140+
- [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](http://twitter.com/tylerleonhardt)
141+
- [David Wilson](https://github.com/daviwil) - [@daviwil](https://twitter.com/daviwil)
140142

141143
## License
142144

docs/azure_data_studio/README_FOR_MARKETPLACE.md

+59-32
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,43 @@
11
# PowerShell Language Support for Azure Data Studio
22

3-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/df06b9909e7442cebc1132bda0b8c0e3)](https://app.codacy.com/app/TylerLeonhardt/vscode-powershell?utm_source=github.com&utm_medium=referral&utm_content=PowerShell/vscode-powershell&utm_campaign=Badge_Grade_Dashboard)
4-
[![Build Status](https://powershell.visualstudio.com/vscode-powershell/_apis/build/status/PowerShell.vscode-powershell?branchName=master)](https://powershell.visualstudio.com/vscode-powershell/_build/latest?definitionId=51&branchName=master)
3+
[![Build Status](https://dev.azure.com/powershell/vscode-powershell/_apis/build/status/PowerShell.vscode-powershell?branchName=master)](https://dev.azure.com/powershell/vscode-powershell/_build/latest?definitionId=51&branchName=master)
4+
[![Version](https://vsmarketplacebadge.apphb.com/version/ms-vscode.PowerShell.svg)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell)
5+
[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/ms-vscode.PowerShell.svg)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell)
6+
[![Discord](https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white)](https://aka.ms/powershell-vscode-discord)
57
[![Join the chat at https://gitter.im/PowerShell/vscode-powershell](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
68

7-
This extension provides rich PowerShell language support for [Azure Data Studio](github.com/Microsoft/azuredatastudio).
9+
This extension provides rich PowerShell language support for [Azure Data Studio](https://github.com/Microsoft/azuredatastudio) (ADS).
810
Now you can write and run PowerShell scripts using the excellent IDE-like interface
911
that Azure Data Studio provides.
1012

11-
## Platform support
13+
This extension is powered by the PowerShell language server,
14+
[PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices).
15+
This leverages the
16+
[Language Server Protocol](https://microsoft.github.io/language-server-protocol/)
17+
where `PowerShellEditorServices` is the server and `vscode-powershell` is the client.
1218

13-
- **Windows 7 through 10** with Windows PowerShell v3 and higher, and PowerShell Core
14-
- **Linux** with PowerShell Core (all PowerShell-supported distributions)
15-
- **macOS** with PowerShell Core
19+
Also included in this extension is the PowerShell ISE theme for Visual Studio Code. It is
20+
not activated by default, but after installing this extension either click "Set Color
21+
Theme" or use the [theme picker](https://code.visualstudio.com/docs/getstarted/themes) and
22+
select "PowerShell ISE" for a fun and familiar experience.
1623

17-
Read the [FAQ](https://github.com/PowerShell/vscode-powershell/wiki/FAQ) for answers to common questions.
24+
## Platform Support
25+
26+
The extension _should_ work anywhere ADS itself and PowerShell Core 7 or higher is
27+
[supported][]. For Windows PowerShell, only version 5.1 is supported. Please note that
28+
PowerShell Core 6 is end-of-life and so not supported. Our test matrix includes the
29+
following:
30+
31+
- **Windows Server 2016 and 2019** with Windows PowerShell 5.1 and PowerShell Core 7.1.4
32+
- **macOS 10.15** with PowerShell Core 7.1.4
33+
- **Ubuntu 20.04** with PowerShell Core 7.1.4
34+
35+
[supported]: https://docs.microsoft.com/en-us/powershell/scripting/powershell-support-lifecycle?view=powershell-7.1#supported-platforms
36+
37+
Read the [installation instructions](https://docs.microsoft.com/en-us/powershell/scripting/components/vscode/using-vscode)
38+
to get more details on how to use the extension on these platforms.
39+
40+
**Read the [troubleshooting guide](./docs/troubleshooting.md) for answers to common questions.**
1841

1942
## Features
2043

@@ -27,28 +50,27 @@ Read the [FAQ](https://github.com/PowerShell/vscode-powershell/wiki/FAQ) for ans
2750
- Document and workspace symbol discovery
2851
- Run selected selection of PowerShell code using <kbd>F8</kbd>
2952
- Launch online help for the symbol under the cursor using <kbd>Ctrl</kbd>+<kbd>F1</kbd>
30-
- Basic interactive console support!
53+
- Local script debugging
54+
- Integrated console support
55+
- PowerShell ISE color theme
3156

3257
## Installing the Extension
3358

3459
You can install the official release of the PowerShell extension by following the steps
35-
in the [Azure Data Studio documentation](docs.microsoft.com/en-us/sql/azure-data-studio/extensions).
60+
in the [Azure Data Studio documentation](https://docs.microsoft.com/en-us/sql/azure-data-studio/extensions).
3661
In the Extensions pane, search for "PowerShell" extension and install it there. You will
3762
get notified automatically about any future extension updates!
3863

39-
You can also install a VSIX package from our [Releases page](https://github.com/PowerShell/vscode-powershell/releases) and install it through the command line:
64+
You can also install a VSIX package from our [Releases page](https://github.com/PowerShell/vscode-powershell/releases) by following the
65+
[Install from a VSIX](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix)
66+
instructions. The easiest way is through the command line:
4067

4168
```powershell
42-
azuredatastudio --install-extension PowerShell-<version>.vsix
69+
azuredatastudio --install-extension powershell-<version>.vsix
4370
```
4471

45-
## Reporting Problems
46-
47-
If you experience any problems with the PowerShell Extension, see
48-
[the troubleshooting docs](./docs/troubleshooting.md) for information
49-
on diagnosing and reporting issues.
72+
## Security Note
5073

51-
#### Security Note
5274
For any security issues, please see [here](./docs/troubleshooting.md#note-on-security).
5375

5476
## Example Scripts
@@ -61,39 +83,38 @@ how to use them.
6183
This folder can be found at the following path:
6284

6385
```powershell
64-
$HOME/.azuredatastudio/extensions/ms-vscode.PowerShell-<version>/examples
65-
```
66-
67-
or if you're using the preview version of the extension
68-
69-
```powershell
70-
$HOME/.azuredatastudio/extensions/ms-vscode.powershell-preview-<version>/examples
86+
$HOME/.azuredatastudio/extensions/ms-vscode.powershell-<version>/examples
7187
```
7288

73-
To open/view the extension's examples in Azure Data Studio, run the following from your PowerShell command prompt:
89+
To open/view the extension's examples in Azure Data Studio, run the following from your
90+
PowerShell session:
7491

7592
```powershell
76-
azuredatastudio (Get-ChildItem $Home\.azuredatastudio\extensions\ms-vscode.PowerShell-*\examples)[-1]
93+
azuredatastudio (Get-ChildItem $HOME/.azuredatastudio/extensions/ms-vscode.powershell-*/examples)[-1]
7794
```
7895

7996
### SQL PowerShell Examples
80-
In order to use these examples (below), you need to install the SqlServer module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/SqlServer).
97+
98+
In order to use these examples (below), you need to install the SqlServer module from the
99+
[PowerShell Gallery](https://www.powershellgallery.com/packages/SqlServer).
81100

82101
```powershell
83102
Install-Module -Name SqlServer
84103
```
85104

86105
> NOTE: With version `21.1.18102` and up, the `SqlServer` module supports [PowerShell Core](https://github.com/PowerShell/PowerShell) 6.2 and up, in addion to Windows PowerShell.
87106
88-
In this example, we use the `Get-SqlInstance` cmdlet to Get the Server SMO objects for ServerA & ServerB. The default output for this command will include the Instance name, version, Service Pack, & CU Update Level of the instances.
107+
In this example, we use the `Get-SqlInstance` cmdlet to Get the Server SMO objects for
108+
ServerA and ServerB. The default output for this command will include the Instance name,
109+
version, Service Pack, and CU Update Level of the instances.
89110

90111
```powershell
91112
Get-SqlInstance -ServerInstance ServerA, ServerB
92113
```
93114

94115
Here is a sample of what that output will look like:
95116

96-
```
117+
```powershell
97118
Instance Name Version ProductLevel UpdateLevel HostPlatform HostDistribution
98119
------------- ------- ------------ ----------- ------------ ----------------
99120
ServerA 13.0.5233 SP2 CU4 Windows Windows Server 2016 Datacenter
@@ -112,7 +133,7 @@ FOREACH {
112133

113134
Here is a sample of what that output will look like:
114135

115-
```
136+
```powershell
116137
Name Status Size Space Recovery Compat. Owner
117138
Available Model Level
118139
---- ------ ---- ---------- -------- ------- -----
@@ -152,9 +173,15 @@ on how to contribute to this extension!
152173

153174
## Maintainers
154175

176+
- [Rob Holt](https://github.com/rjmholt) - [@rjmholt](https://twitter.com/rjmholt)
177+
- [Andy Schwartzmeyer](https://github.com/andschwa) - [andschwa.com](https://andschwa.com/)
178+
- [Sydney Smith](https://github.com/SydneyhSmith) - [@SydneyhSmith](https://github.com/SydneyhSmith)
179+
180+
### Emeriti
181+
155182
- [Keith Hill](https://github.com/rkeithhill) - [@r_keith_hill](http://twitter.com/r_keith_hill)
156183
- [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](http://twitter.com/tylerleonhardt)
157-
- [Rob Holt](https://github.com/rjmholt)
184+
- [David Wilson](https://github.com/daviwil) - [@daviwil](https://twitter.com/daviwil)
158185

159186
## License
160187

0 commit comments

Comments
 (0)