Skip to content

Commit cf9f239

Browse files
committed
Update README.md
Update readme to reflect the changes in the project name.
1 parent dba3417 commit cf9f239

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Introduction
22
============
33

4-
ScriptAnalyzer is a static code checker for Windows PowerShell modules and scripts. ScriptAnalyzer checks the quality of Windows PowerShell code by running a set of rules. The rules are based on PowerShell best practices identified by PowerShell Team and the community. It generates DiagnosticResults (errors and warnings) to inform users about potential code defects and suggests possible solutions for improvements.
4+
PSScriptAnalyzer is a static code checker for Windows PowerShell modules and scripts. PSScriptAnalyzer checks the quality of Windows PowerShell code by running a set of rules. The rules are based on PowerShell best practices identified by PowerShell Team and the community. It generates DiagnosticResults (errors and warnings) to inform users about potential code defects and suggests possible solutions for improvements.
55

6-
ScriptAnalyzer is shipped with a collection of built-in rules that checks various aspects of PowerShell code such as presence of uninitialized variables, usage of PSCredential Type, usage of Invoke-Expression etc. Additional functionalities such as exclude/include specific rules are also supported.
6+
PSScriptAnalyzer is shipped with a collection of built-in rules that checks various aspects of PowerShell code such as presence of uninitialized variables, usage of PSCredential Type, usage of Invoke-Expression etc. Additional functionalities such as exclude/include specific rules are also supported.
77

8-
ScriptAnalyzer cmdlets
8+
PSScriptAnalyzer cmdlets
99
======================
1010
```
1111
Get-ScriptAnalyzerRule [-CustomizedRulePath <string[]>] [-Name <string[]>] [<CommonParameters>]
@@ -21,7 +21,7 @@ WS2012R2 / Windows 8.1 / Windows OS running PowerShell v5.0 which can be obtaine
2121
Installation
2222
============
2323

24-
1. Build the Code using Visual Studio [solution part of the repo] and navigate to the binplace location [``~/ProjectRoot/ScriptAnalyzer``]
24+
1. Build the Code using Visual Studio [solution part of the repo] and navigate to the binplace location [``~/ProjectRoot/PSScriptAnalyzer``]
2525

2626
2. In PowerShell Console:
2727
```powershell
@@ -33,12 +33,12 @@ To confirm installation: run ```Get-ScriptAnalyzerRule``` in the PowerShell cons
3333
Building the Code
3434
=================
3535

36-
Use Visual Studio to build "ScriptAnalyzer.sln". Use ~/ScriptAnalyzer/ folder to load PSScriptAnalyzer.psd1
36+
Use Visual Studio to build "ScriptAnalyzer.sln". Use ~/PSScriptAnalyzer/ folder to load PSScriptAnalyzer.psd1
3737

3838
Running Tests
3939
=============
4040

41-
Pester-based ScriptAnalyzer Tests are located in ```<branch>/ScriptAnalyzer/Tests``` folder
41+
Pester-based ScriptAnalyzer Tests are located in ```<branch>/PSScriptAnalyzer/Tests``` folder
4242

4343
* Ensure Pester is installed on the machine
4444
* Go the Tests folder in your local repository
@@ -53,7 +53,7 @@ Contributing to ScriptAnalyzer
5353

5454
You are welcome to contribute to this project. There are many ways to contribute:
5555

56-
1. Submit a bug report via [Issues]( https://github.com/PowerShell/ScriptAnalyzer/issues). For a guide to submitting good bug reports, please read [Painless Bug Tracking](http://www.joelonsoftware.com/articles/fog0000000029.html).
56+
1. Submit a bug report via [Issues]( https://github.com/PowerShell/PSScriptAnalyzer/issues). For a guide to submitting good bug reports, please read [Painless Bug Tracking](http://www.joelonsoftware.com/articles/fog0000000029.html).
5757
2. Verify fixes for bugs.
5858
3. Submit your fixes for a bug. Before submitting, please make sure you have:
5959
* Performed code reviews of your own
@@ -68,4 +68,4 @@ You are welcome to contribute to this project. There are many ways to contribute
6868

6969
You might also read these two blog posts about contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza, and [Don’t “Push” Your Pull Requests](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik.
7070

71-
Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via [Issues](https://github.com/PowerShell/ScriptAnalyzer/issues), and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed by the Windows PowerShell Team. Only those that meet a high bar for both quality and roadmap fit will be merged into the source.
71+
Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via [Issues](https://github.com/PowerShell/PSScriptAnalyzer/issues), and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed by the Windows PowerShell Team. Only those that meet a high bar for both quality and roadmap fit will be merged into the source.

0 commit comments

Comments
 (0)