Update readme and docs (#93)

* Update readme and docs * forgot to import module before updating docs * delete Find-SteamAppID
hjorslev · May 18, 2024 · 77e53ad · 77e53ad
1 parent 62f8ada
commit 77e53ad
Show file tree

Hide file tree

Showing 21 changed files with 502 additions and 498 deletions.
diff --git a/README.md b/README.md
@@ -29,25 +29,25 @@ for server information and more.
 
 ## Command Reference
 
-| Cmdlet                                                   | Description                                                         |
-| -------------------------------------------------------- | ------------------------------------------------------------------- |
-| [Connect-SteamAPI](docs/Connect-SteamAPI.md)             | Create or update the Steam Web API config file.                     |
-| [Disconnect-SteamAPI](docs/Disconnect-SteamAPI.md)          | Disconnects from the Steam API by removing the stored API key.      |
-| [Find-SteamAppID](docs/Find-SteamAppID.md)               | Find a Steam AppID by searching the name of the application.        |
-| [Get-SteamFriendList](docs/Get-SteamFriendList.md)       | Returns the friend list of any Steam user.                          |
-| [Get-SteamNews](docs/Get-SteamNews.md)                   | Returns the latest news of a game specified by its AppID.           |
-| [Get-SteamPlayerBan](docs/Get-SteamPlayerBan.md)         | Returns Community, VAC, and Economy ban statuses for given players. |
-| [Get-SteamPlayerSummary](docs/Get-SteamPlayerSummary.md) | Returns basic profile information for a list of 64-bit Steam IDs.   |
-| [Get-SteamServerInfo](docs/Get-SteamServerInfo.md)       | Query a running Steam based game server.                            |
-| [Install-SteamCMD](docs/Install-SteamCMD.md)             | Downloads and installs SteamCMD.                                    |
-| [Resolve-VanityURL](docs/Resolve-VanityURL.md)           | Resolve a vanity URL (also named custom URL).                       |
-| [Update-SteamApp](docs/Update-SteamApp.md)               | Install or update a Steam application using SteamCMD.               |
-| [Update-SteamServer](docs/Update-SteamServer.md)         | Update a Steam based game server through a workflow.                |
+| Cmdlet                                                   | Description                                                                                      |
+| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
+| [Connect-SteamAPI](docs/Connect-SteamAPI.md)             | Create or update the Steam Web API config file.                                                  |
+| [Disconnect-SteamAPI](docs/Disconnect-SteamAPI.md)       | Disconnects from the Steam API by removing the stored API key.                                   |
+| [Get-SteamApp](docs/Get-SteamApp.md)                     | Retrieves the name and ID of a Steam application by searching the name or ID of the application. |
+| [Get-SteamFriendList](docs/Get-SteamFriendList.md)       | Returns the friend list of any Steam user.                                                       |
+| [Get-SteamNews](docs/Get-SteamNews.md)                   | Returns the latest news of a game.                                                               |
+| [Get-SteamPlayerBan](docs/Get-SteamPlayerBan.md)         | Returns Community, VAC, and Economy ban statuses for any given players.                              |
+| [Get-SteamPlayerSummary](docs/Get-SteamPlayerSummary.md) | Returns basic profile information for a list of 64-bit Steam IDs.                                |
+| [Get-SteamServerInfo](docs/Get-SteamServerInfo.md)       | Query a running Steam based game server.                                                         |
+| [Install-SteamCMD](docs/Install-SteamCMD.md)             | Downloads and installs SteamCMD.                                                                 |
+| [Resolve-VanityURL](docs/Resolve-VanityURL.md)           | Resolve a vanity URL (also named custom URL).                                                    |
+| [Update-SteamApp](docs/Update-SteamApp.md)               | Install or update a Steam application using SteamCMD.                                            |
+| [Update-SteamServer](docs/Update-SteamServer.md)         | Update a Steam based game server through a workflow.                                             |
 
 ## Prerequisites
 
 - Windows based OS
-- Windows PowerShell 5.1 / PowerShell 6+
+- Windows PowerShell 5.1 / PowerShell 7.
 
 You can find your version of PowerShell by using:
 
@@ -127,7 +127,7 @@ Update-SteamApp -ApplicationName 'Ground Branch Dedicated Server' -Path 'C:\Dedi
 In this example we install _ARK: SurvivalEvolved Dedicated Server_ by using its
 AppID. The AppID can be found by using a database such as
 [Steam Database](https://steamdb.info/) or by searching for the AppID with the cmdlet
-`Find-SteamAppID` e.g. `Find-SteamAppID -ApplicationName 'Counter-Strike'`.
+`Get-SteamApp` e.g. `Get-SteamApp -ApplicationName 'Counter-Strike'`.
 
 ```powershell
 Update-SteamApp -AppID 376030 -Path 'C:\DedicatedServers\ARK-SurvivalEvolved'

diff --git a/SteamPS/Public/API/Connect-SteamAPI.ps1 b/SteamPS/Public/API/Connect-SteamAPI.ps1
@@ -9,6 +9,7 @@ function Connect-SteamAPI {
 
     .EXAMPLE
     Connect-SteamAPI
+
     Prompts the user for a Steam Web API key and sets the specified input within
     the config file.
 

diff --git a/SteamPS/Public/API/Get-SteamApp.ps1 b/SteamPS/Public/API/Get-SteamApp.ps1
@@ -1,23 +1,21 @@
 function Get-SteamApp {
     <#
     .SYNOPSIS
-    Retrieves a Steam AppID by searching the name or ID of the application.
+    Retrieves the name and ID of a Steam application by searching the name or
+    ID of the application.
 
     .DESCRIPTION
-    This function searches for a Steam application by name or ID and returns the corresponding AppID. If multiple applications are found, the user can select the correct one from a list.
+    This function searches for a Steam application by name or ID and returns the
+    corresponding application ID and name. If multiple applications are found,
+    the user can select the correct one from a list.
 
     .PARAMETER ApplicationName
-    The name of the application to search for. If multiple applications are found, the user will be presented with a list from which they can select the correct application.
+    The name of the application to search for. If multiple applications are found,
+    the user will be presented with a list from which they can select the correct application.
 
     .PARAMETER ApplicationID
     The unique identifier for a Steam application. Use this parameter to search for an application by its ID.
 
-    .INPUTS
-    System.String or System.Int32. Get-SteamApp accepts either a string value for the application name or an integer value for the application ID.
-
-    .OUTPUTS
-    PSCustomObject. This function returns a custom object with the application name and application ID.
-
     .EXAMPLE
     Get-SteamApp -ApplicationName 'Ground Branch'
 
@@ -28,6 +26,12 @@
 
     Searches for the application with the AppID 440 and returns its name and ID.
 
+    .INPUTS
+    System.String or System.Int32. Get-SteamApp accepts either a string value for the application name or an integer value for the application ID.
+
+    .OUTPUTS
+    PSCustomObject. This function returns a custom object with the application name and application ID.
+
     .NOTES
     Author: Frederik Hjorslev Nylander
 
@@ -56,8 +60,8 @@
     )
 
     begin {
-            Write-Verbose -Message 'Fetching app list from Steam Web API.'
-            $SteamApps = (Invoke-RestMethod -Uri 'https://api.steampowered.com/ISteamApps/GetAppList/v2/' -UseBasicParsing).applist.apps
+        Write-Verbose -Message 'Fetching app list from Steam Web API.'
+        $SteamApps = (Invoke-RestMethod -Uri 'https://api.steampowered.com/ISteamApps/GetAppList/v2/' -UseBasicParsing).applist.apps
     }
 
     process {

diff --git a/SteamPS/Public/API/Get-SteamFriendList.ps1 b/SteamPS/Public/API/Get-SteamFriendList.ps1
@@ -1,7 +1,7 @@
 function Get-SteamFriendList {
     <#
     .SYNOPSIS
-    Fetches the friend list of tje specified Steam user.
+    Fetches the friend list of the specified Steam user.
 
     .DESCRIPTION
     This cmdlet fetches the friend list of a Steam user using the provided SteamID64. It retrieves data only from public profiles.
@@ -14,17 +14,17 @@
 
     .EXAMPLE
     Get-SteamFriendList -SteamID64 76561197960435530
+
     This example fetches the friend list of the user with the specified SteamID64.
 
     .INPUTS
     System.Int64
 
     .OUTPUTS
-    Outputs a string formatted as JSON, XML, or VDF representing the user's friend list.
-    The friend list includes the following properties:
-    - steamid: The friend's 64-bit Steam ID.
-    - relationship: The qualifier of the relationship.
-    - friend_since: The Unix timestamp indicating when the relationship was established.
+    PSCustomObject. It returns the following properties:
+    - SteamID64: The friend's 64-bit Steam ID.
+    - Relationship: The qualifier of the relationship.
+    - FriendSince: The Unix timestamp indicating when the relationship was established.
 
     .NOTES
     Author: Frederik Hjorslev Nylander

diff --git a/SteamPS/Public/API/Get-SteamPlayerBan.ps1 b/SteamPS/Public/API/Get-SteamPlayerBan.ps1
@@ -4,7 +4,7 @@
     Fetches ban information for Steam players.
 
     .DESCRIPTION
-    This cmdlet fetches ban information for Steam players. The information includes whether the players are banned from the Steam Community, have VAC bans, the number of VAC bans, days since the last ban, number of game bans, and economy ban status.
+    This cmdlet fetches ban information about Steam players. The information includes whether the players are banned from the Steam Community, have VAC bans, the number of VAC bans, days since the last ban, number of game bans, and economy ban status.
 
     .PARAMETER SteamID64
     Specifies one or more 64-bit Steam IDs for which to fetch ban information. Enter the Steam IDs as a comma-separated list.
@@ -18,7 +18,7 @@
     int64[]: Specifies an array of 64-bit integers representing Steam IDs.
 
     .OUTPUTS
-    Returns objects with the following properties:
+    Returns a PSCustomObject with the following properties:
 
     - SteamID64: The player's 64-bit ID.
     - CommunityBanned: A boolean indicating whether the player is banned from the Steam Community.

diff --git a/SteamPS/Public/API/Get-SteamPlayerSummary.ps1 b/SteamPS/Public/API/Get-SteamPlayerSummary.ps1
@@ -4,7 +4,7 @@
     Fetches basic profile information for a list of 64-bit Steam IDs.
 
     .DESCRIPTION
-    Fetches basic profile information for a list of 64-bit Steam IDs.
+    Fetches basic profile information from the Steam Community.
 
     .PARAMETER SteamID64
     Specifies a comma-separated list of 64-bit Steam IDs to fetch profile information for. Up to 100 Steam IDs can be requested.

diff --git a/SteamPS/Public/API/Resolve-VanityURL.ps1 b/SteamPS/Public/API/Resolve-VanityURL.ps1
@@ -14,6 +14,7 @@
 
     .EXAMPLE
     Resolve-VanityURL -VanityURL user
+
     This example retrieves the SteamID64 linked to the vanity URL 'user'.
 
     .EXAMPLE

diff --git a/SteamPS/Public/Server/Install-SteamCMD.ps1 b/SteamPS/Public/Server/Install-SteamCMD.ps1
@@ -8,7 +8,7 @@ function Install-SteamCMD {
     predefined location (C:\Program Files\SteamCMD).
 
     .PARAMETER InstallPath
-    Specifiy the install location of SteamCMD.
+    Specify the install location of SteamCMD.
 
     .PARAMETER Force
     The Force parameter allows the user to skip the "Should Continue" box.

diff --git a/docs/Connect-SteamAPI.md b/docs/Connect-SteamAPI.md
@@ -1,6 +1,6 @@
 ---
 external help file: SteamPS-help.xml
-Module Name: steamps
+Module Name: SteamPS
 online version: https://hjorslev.github.io/SteamPS/Connect-SteamAPI.html
 schema: 2.0.0
 ---
@@ -13,7 +13,7 @@ Create or update the Steam Web API config file.
 ## SYNTAX
 
 ```
-Connect-SteamAPI [<CommonParameters>]
+Connect-SteamAPI [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -32,6 +32,21 @@ the config file.
 
 ## PARAMETERS
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 

diff --git a/docs/Find-SteamAppID.md b/docs/Find-SteamAppID.md