gavin/Chronometer
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
KevinMarquette
2017-02-05 15:06:45 -08:00
parent 207b60fa00
commit 0ce734e8c9
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -2,24 +2,35 @@
A module for measuring performance of Powershell scripts, one line at a time A module for measuring performance of Powershell scripts, one line at a time
## Project status ## Project status
Experimental. Just a working idea at the moment. Functions and argument names are still up in the air. Also don't consider it stable or tested. Use at your own risk. Preview release. The core logic is fleshed out but more testing is needed.
# Getting started # Getting started
## Prerequirements ## Prerequirements
You need to have Powershell 5.0 or newer. This module uses classes. You need to have Powershell 5.0 or newer. This module uses classes.
## Installing Chronometer ## Installing Chronometer
Place the Chronometer folder into your `$PSModulePath`. I will publish to the Powershell Gallery once the project is more stable. This is published in the Powershell Gallery
Install-Module Chronometer
## Basic usage ## Basic usage
Provide a script file and a command to execute. Provide a script file and a command to execute.
$path = myscript.ps1 $path = myscript.ps1
$Chronometer = Get-Chronometer -Path $path -Script {. .\myscript.ps1} $Chronometer = Get-Chronometer -Path $path -Script {. .\myscript.ps1}
$Chronometer | % tostring | Format-Chronometer $Chronometer | Format-Chronometer
The user experience is important to me but I am working on the core logic right now. I will loop back to make it more intuitive and simple to use.
## Things to know ## Things to know
The `Path` can be any ps1 and the script can run any command. Ideally, you would either execute the script or load the script and execute a command inside it. The `Path` can be any ps1 and the script can run any command. Ideally, you would either execute the script or load the script and execute a command inside it.
Here is a more complex example:
$script = ls C:\workspace\PSGraph\PSGraph -Recurse -Filter *.ps1
$Chronometer = @{
Path = $script.fullname
Script = {Invoke-Pester C:\workspace\PSGraph}
}
$results = Get-Chronometer @Chronometer
$results | Format-Chronometer