8000 updated README to include testing · ModuleBuild/ModuleBuild@94eddd0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 94eddd0

Browse files
committed
updated README to include testing
1 parent 9170023 commit 94eddd0

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

Readme.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ and import the module to your session to test, but not install this module.
2626
## Features
2727

2828
This build framework for PowerShell modules comes with several appealing baked in features which include;
29+
2930
- Fully portable project directory structure and build process. So portable that you can copy it to another PowerShell 5.0 capable system and it should run the same.
3031
- Automatically combine your public and private functions into one clean psm1 file at build time.
3132
- Automatically update your psd1 file with public functions at build time.
@@ -37,6 +38,7 @@ This build framework for PowerShell modules comes with several appealing baked i
3738
- Includes ability to scan for sensitive terms (like your company domain name or other items that you may not want published)
3839
- Functions for importing public and private functions from other projects into a ModuleBuild project
3940
- Add new public functions to your project based on easy to create templates.
41+
4042
## Documentation
4143

4244
Visit the [ReadTheDocs.org documentation](http://modulebuild.readthedocs.io/en/latest/) that this module created a manifest for automatically.
@@ -52,8 +54,12 @@ Studio Code and ensure that the PowerShell extension is installed.
5254

5355
More contributing information can be found [here](https://github.com/zloeber/ModuleBuild/blob/master/docs/Contributing.md).
5456

57+
This module is tested with the PowerShell testing framework Pester. To run all tests, just start the included build scrip with the test param `.\Build.ps1 -test`.
58+
5559
## Other Information
5660

57-
**Author:** [Zachary Loeber](https://www.the-little-things.net)
61+
**Authors:**
62+
- [Zachary Loeber](https://www.the-little-things.net)
63+
- [Justin Perdok](https://github.com/justin-p)
5864

5965
**Website:** https://github.com/zloeber/ModuleBuild

plugins/plaster/template/scaffold/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Studio Code and ensure that the PowerShell extension is installed.
3636
* [Visual Studio Code](https://code.visualstudio.com/)
3737
* [PowerShell Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell)
3838

39+
This module is tested with the PowerShell testing framework Pester. To run all tests, just start the included build scrip with the test param `.\Build.ps1 -test`.
40+
3941
## Other Information
4042

4143
**Author:** <%=$PLASTER_PARAM_ModuleAuthor%>

0 commit comments

Comments
 (0)
0