Skip to content

Commit

Permalink
expanded README
Browse files Browse the repository at this point in the history
  • Loading branch information
jdhitsolutions committed Dec 15, 2017
1 parent c9b3b80 commit 8cc2ad8
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can also install from the PowerShell Gallery:
```
Install-Module PSTypeExtensionTools
```
## Example
## Why you want to use this
Let's say you want to update a number object, but you have no idea what the type name is. Once you have read help for the commands in this module you could run a PowerShell command like this:
```
PS C:\> 123 | Get-PSType |
Expand Down Expand Up @@ -70,6 +70,10 @@ In your PowerShell profile script you can then re-import the type extension defi
```
Import-PSTypeExtension -Path C:\work\int32-types.json
```
## Create ps1xml files
The export command makes it easy to construct a ps1xml file. All you need to do is provide the type name and the extensions you want to export, and it will create a properly formatted ps1xml file that you can import into a session with `Update-TypeData` or distribute with a module. No more clunky XML copying, pasting and hoping for the best.

## I want to try
You can find a number of type extension exports in the [Samples](./samples) folder.

## PSTypeExtensionTools Cmdlets
Expand All @@ -90,4 +94,10 @@ Import type extension definitions from a json file or xml.

This project was first described at http://jdhitsolutions.com/blog/powershell/5777/a-powershell-module-for-your-type-extensions

There is also an about topic you can read:

```
help about_pstypeextensiontools
```

*last updated 15 December 2017*

0 comments on commit 8cc2ad8

Please sign in to comment.