Update documentation

Akaizoku · Feb 26, 2020 · abd6b23 · abd6b23
1 parent ced138c
commit abd6b23
Show file tree

Hide file tree

Showing 3 changed files with 150 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,70 @@
+# Changelog
+All notable changes to the [PSRP](https://github.com/Akaizoku/PSRP) project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1](https://github.com/Akaizoku/PSRP/releases/tag/1.0.1) - 2020-02-26
+
+Update
+
+### Added
+
+The following function has been added:
+-   Start-ContractSelection
+
+The following file has been added:
+-   CHANGELOG
+
+### Changed
+
+The following files have been updated:
+-   README
+
+## [1.0.0](https://github.com/Akaizoku/PSRP/releases/tag/1.0.0) - 2020-02-21
+
+### Added
+
+The following functions have been added:
+-   Backup-Schema
+-   Get-ModelID
+-   Get-JavaClass
+-   Get-RiskProBatchResult
+-   Get-SolveID
+-   Grant-Role
+-   Invoke-CreateModel
+-   Invoke-CreateModelGroup
+-   Invoke-CreateUser
+-   Invoke-CreateUserGroup
+-   Invoke-DeleteModel
+-   Invoke-DeleteModelGroup
+-   Invoke-DeleteUser
+-   Invoke-List
+-   Invoke-MakeDir
+-   Invoke-MigratorTool
+-   Invoke-ModifyModel
+-   Invoke-ModifyModelGroup
+-   Invoke-ModifyUser
+-   Invoke-RiskProANTClient
+-   Invoke-RiskProBatchClient
+-   Invoke-Upload
+-   Restore-Schema
+-   Set-UserPassword
+-   Start-CleanRollupSolve
+-   Start-ExportToExcel
+-   Start-ImportXML
+-   Start-Maintenance
+-   Start-RollupSolve
+-   Start-Solve
+-   Test-MigratorToolOutcome
+-   Test-Model
+-   Test-RiskProBatchClientOutcome
+-   Test-Solve
+-   Unlock-User
+-   Write-MigratorToolCmd
+-   Write-RiskProANTCmd
+-   Write-RiskProBatchClientCmd
+
+The following files have been added:
+-   LICENSE
+-   README
diff --git a/PSRP.psd1 b/PSRP.psd1
@@ -12,7 +12,7 @@
 RootModule = 'PSRP.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.0.0'
+ModuleVersion = '1.0.1'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -69,7 +69,42 @@ PowerShellVersion = '3.0'
 # NestedModules = @()
 
 # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = '*'
+FunctionsToExport = @(
+  "Backup-Schema",
+  "Get-ModelID",
+  "Get-RiskProBatchResult",
+  "Get-SolveID",
+  "Grant-Role",
+  "Invoke-CreateModel",
+  "Invoke-CreateModelGroup",
+  "Invoke-CreateUser",
+  "Invoke-CreateUserGroup",
+  "Invoke-DeleteModel",
+  "Invoke-DeleteModelGroup",
+  "Invoke-DeleteUser",
+  "Invoke-List",
+  "Invoke-MakeDir",
+  "Invoke-MigratorTool",
+  "Invoke-ModifyModel",
+  "Invoke-ModifyModelGroup",
+  "Invoke-ModifyUser",
+  "Invoke-RiskProANTClient",
+  "Invoke-RiskProBatchClient",
+  "Invoke-Upload",
+  "Restore-Schema",
+  "Set-UserPassword",
+  "Start-CleanRollupSolve",
+  "Start-ExportToExcel",
+  "Start-ImportXML",
+  "Start-Maintenance",
+  "Start-RollupSolve",
+  "Start-Solve",
+  "Test-MigratorToolOutcome",
+  "Test-Model",
+  "Test-RiskProBatchClientOutcome",
+  "Test-Solve",
+  "Unlock-User"
+)
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
 CmdletsToExport = @()
@@ -108,8 +143,8 @@ PrivateData = @{
 
         # ReleaseNotes of this module
         ReleaseNotes = @'
-[1.0.0]
-Framework for basic administration functions.
+[1.0.1]
+Add contract selection function and change log
 '@
 
     } # End of PSData hashtable

diff --git a/README.md b/README.md
@@ -17,8 +17,9 @@ RiskPro PowerShell module (PSRP) is a framework for the automation of tasks for
 ### Installation
 
 There are two ways of setting up the WildFly PowerShell Module on your system:
-1. Download the `PSRP` module from the [Github repository](https://github.com/Akaizoku/PSRP);
-1. Install the `PSRP` module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PSRP).
+
+1.  Download the `PSRP` module from the [Github repository](https://github.com/Akaizoku/PSRP);
+2.  Install the `PSRP` module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PSRP).
 
 ```powershell
 Install-Module -Name "PSRP" -Repository "PSGallery"
@@ -36,6 +37,44 @@ Import-Module -Name "PSRP"
 Get-Command -Module "PSRP"
 ```
 
+| CommandType | Name                           | Version | Source |
+| ----------- | ------------------------------ | ------- | ------ |
+| Function    | Backup-Schema                  | 1.0.1   | PSRP   |
+| Function    | Get-ModelID                    | 1.0.1   | PSRP   |
+| Function    | Get-RiskProBatchResult         | 1.0.1   | PSRP   |
+| Function    | Get-SolveID                    | 1.0.1   | PSRP   |
+| Function    | Grant-Role                     | 1.0.1   | PSRP   |
+| Function    | Invoke-CreateModel             | 1.0.1   | PSRP   |
+| Function    | Invoke-CreateModelGroup        | 1.0.1   | PSRP   |
+| Function    | Invoke-CreateUser              | 1.0.1   | PSRP   |
+| Function    | Invoke-CreateUserGroup         | 1.0.1   | PSRP   |
+| Function    | Invoke-DeleteModel             | 1.0.1   | PSRP   |
+| Function    | Invoke-DeleteModelGroup        | 1.0.1   | PSRP   |
+| Function    | Invoke-DeleteUser              | 1.0.1   | PSRP   |
+| Function    | Invoke-List                    | 1.0.1   | PSRP   |
+| Function    | Invoke-MakeDir                 | 1.0.1   | PSRP   |
+| Function    | Invoke-MigratorTool            | 1.0.1   | PSRP   |
+| Function    | Invoke-ModifyModel             | 1.0.1   | PSRP   |
+| Function    | Invoke-ModifyModelGroup        | 1.0.1   | PSRP   |
+| Function    | Invoke-ModifyUser              | 1.0.1   | PSRP   |
+| Function    | Invoke-RiskProANTClient        | 1.0.1   | PSRP   |
+| Function    | Invoke-RiskProBatchClient      | 1.0.1   | PSRP   |
+| Function    | Invoke-Upload                  | 1.0.1   | PSRP   |
+| Function    | Restore-Schema                 | 1.0.1   | PSRP   |
+| Function    | Set-UserPassword               | 1.0.1   | PSRP   |
+| Function    | Start-CleanRollupSolve         | 1.0.1   | PSRP   |
+| Function    | Start-ContractSelection        | 1.0.1   | PSRP   |
+| Function    | Start-ExportToExcel            | 1.0.1   | PSRP   |
+| Function    | Start-ImportXML                | 1.0.1   | PSRP   |
+| Function    | Start-Maintenance              | 1.0.1   | PSRP   |
+| Function    | Start-RollupSolve              | 1.0.1   | PSRP   |
+| Function    | Start-Solve                    | 1.0.1   | PSRP   |
+| Function    | Test-MigratorToolOutcome       | 1.0.1   | PSRP   |
+| Function    | Test-Model                     | 1.0.1   | PSRP   |
+| Function    | Test-RiskProBatchClientOutcome | 1.0.1   | PSRP   |
+| Function    | Test-Solve                     | 1.0.1   | PSRP   |
+| Function    | Unlock-User                    | 1.0.1   | PSRP   |
+
 ## Dependencies
 
 This module depends on the usage of functions provided by the [PowerShell Tool Kit (PSTK)](https://www.powershellgallery.com/packages/PSTK/) module.