Skip to content

Commit

Permalink
Updated readme.md with newest function syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
texhex committed Jun 17, 2020
1 parent b615bfb commit 96c8c56
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
9 changes: 8 additions & 1 deletion MPSXM-GenerateMD.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,16 @@ Import-Module "$PSScriptRoot\MPSXM.psm1" -Force




Clear-Host

write-host "-------------------------------------------------------------------------------"
write-host "-------------------------------------------------------------------------------"
write-host "-------------------------------------------------------------------------------"
write-host "-------------------------------------------------------------------------------"
write-host "-------------------------------------------------------------------------------"
write-host "-------------------------------------------------------------------------------"
write-host "-------------------------------------------------------------------------------"

#Document all in MPSXM by using a function from MPSXM :)
Get-QuickReference -Module "MPSXM" -Output CommonMark
#-SortByNoun
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Examples for each function are included in ``MPSXM-QuickTests.ps1``.
<!---------------------------------- START HERE ---------------------------------->



### Add-RegistryValue

Adds a value to the given registry path. Uses [Set-RegistryValue] internally.
Expand Down Expand Up @@ -242,7 +241,7 @@ Get-PropertyValueSafe [[-InputObject] <Object>] [[-Property] <Object>] [[-Defaul

### Get-QuickReference

Returns a quick reference about the given function or all functions in the module. The text returned includes function name, call syntax and parameters extracted from the function itself.
Returns a quick reference about the given function or all functions in the module. The text returned includes function name, call syntax and parameters extracted from the function itself.
If you are on GitHub: the entire reference page was generated with it.

```powershell
Expand Down Expand Up @@ -350,8 +349,7 @@ Get-TrimmedString [[-String] <String>] -RemoveAll
- *StartOnly* - Only remove leading white-space chracters
- *EndOnly* - Only remove trailing white-space chracters
- *Equalize* - Removes all leading and trailing white-space characters, then replace any character considered to be a white-space with the standard white-space character (U+0020)
- *RemoveDuplicates* - Removes all leading and trailing white-space characters, then replace any white-space duplicates with one white-space (U+0020); any non-standard white-space characters will also be re
placed.
- *RemoveDuplicates* - Removes all leading and trailing white-space characters, then replace any white-space duplicates with one white-space (U+0020); any non-standard white-space characters will also be replaced.
- *RemoveAll* - Removes all white-space chracters from the string


Expand Down Expand Up @@ -575,16 +573,18 @@ Test-String [[-String] <String>] -HasData
Test-String [[-String] <String>] -IsNullOrWhiteSpace
Test-String [[-String] <String>] -Contains [[-SearchFor] <String>] [-CaseSensitive]
Test-String [[-String] <String>] -StartsWith [[-SearchFor] <String>] [-CaseSensitive]
Test-String [[-String] <String>] -EndsWith [[-SearchFor] <String>] [-CaseSensitive]
```

- *String* - The string the specified operation should be performed on
- *HasData* - Returns true if the string contains data (not $null, empty or only white spaces)
- *IsNullOrWhiteSpace* - Returns true if the string is either $null, empty, or consists only of white-space characters.
- *Contains* - Returns true if string contains the text in SearchFor. A case-insensitive (ABCD = abcd) is performed by default. If any of the strings do not contain data, $false is returned.
- *StartsWith* - Returns true if the string starts with the text in SearchFor. A case-insensitive (ABCD = abcd) is performed by default. If any of the strings do not contain data, $false is returned.
- *Contains* - Returns true if string contains the text in SearchFor. A case-insensitive (ABCD = abcd) is performed by default. If this parameter or SearchFor does not contain data, $false is returned.
- *StartsWith* - Returns true if the string starts with the text in SearchFor. A case-insensitive (ABCD = abcd) is performed by default. If this parameter or SearchFor does not contain data, $false is returned.
- *EndsWith* - Returns true if the string ends with the text in SearchFor. A case-insensitive (ABCD = abcd) is performed by default. If this parameter or SearchFor does not contain data, $false is returned.
- *SearchFor* - The string beeing sought
- *CaseSensitive* - Perform an operation that respect letter casing, so [ABC] is different from [aBC
- *CaseSensitive* - Perform an operation that respect letter casing, so [ABC] is different from [aBC].

<!---------------------------------- STOP HERE ---------------------------------->
<!---------------------------------- STOP HERE ---------------------------------->
<!---------------------------------- STOP HERE ---------------------------------->
Expand All @@ -593,4 +593,4 @@ Test-String [[-String] <String>] -StartsWith [[-SearchFor] <String>] [-CaseSensi
Any constructive contribution is very welcome! If you encounter a bug or have an addition, please create a [new issue](https://github.com/texhex/MPSXM/issues/new).

## License
Copyright © 2010-2018 [Michael Hex](http://www.texhex.info/). Licensed under the **Apache 2 License**. For details, please see LICENSE.txt.
Copyright © 2010-2020 [Michael Hex](http://www.texhex.info/). Licensed under the **Apache 2 License**. For details, please see LICENSE.txt.

0 comments on commit 96c8c56

Please sign in to comment.