Finished documentation

Author: ITNinja01

FreeChuckNorrisJokes.psd1

@@ -1,9 +1,9 @@
 #
 # Module manifest for module 'FreeChuckNorrisJokes'
 #
-# Generated by: ITNinja
+# Generated by: ITNinja01
 #
-# Generated on: 4/30/2025
+# Generated on: 5/5/2025
 #
 
 @{
@@ -12,16 +12,16 @@
 RootModule = 'FreeChuckNorrisJokes.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.0.1'
+ModuleVersion = '1.0.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
 
 # ID used to uniquely identify this module
-GUID = '26758e38-199f-44fe-a74c-d76deb40f755'
+GUID = 'bd906a89-16e9-4b5a-977e-93ca73bebda8'
 
 # Author of this module
-Author = 'ITNinja'
+Author = 'ITNinja01'
 
 # Company or vendor of this module
 CompanyName = 'ITNinja01'
@@ -95,7 +95,7 @@ PrivateData = @{
     PSData = @{
 
         # Tags applied to this module. These help with module discovery in online galleries.
-        # Tags = @()
+        Tags = 'humor', 'jokes', 'funny', 'comedy', 'action hero'
 
         # A URL to the license for this module.
         LicenseUri = 'https://github.com/ITNinja01/PowerShell/blob/main/LICENSE'

FreeChuckNorrisJokes.psm1

@@ -1,3 +1,25 @@
+<#
+.SYNOPSIS
+A PowerShell module to fetch random Chuck Norris jokes from the Chuck Norris API.    
+.DESCRIPTION
+This module provides two functions to fetch Chuck Norris jokes. The first function retrieves a random joke, while the second function allows the user to specify a category for the joke. The categories are validated against a predefined list of valid categories.
+.EXAMPLE
+get-chucknorrisjoke
+This command fetches a random Chuck Norris joke from the API and displays it in the console.
+get-chucknorrisjokebycategory
+This command prompts the user to enter a category and fetches a random Chuck Norris joke from that category. If the user enters an invalid category, it will prompt them again until a valid category is provided.
+.LINK
+https://api.chucknorris.io/
+.OUTPUTS
+Funny Chuck Norris jokes in the console.
+.NOTES
+author: ITNinja01
+gitHub: https://github.com/ITNin
+First module never published on PSGallery
+Date: 05-04-2025
+version: 1.0.0
+#>
+
 function Get-ChuckNorrisJoke {
     $Joke = invoke-restMethod -Uri 'https://api.chucknorris.io/jokes/random' | select value -ExpandProperty value
     write-host "Chuck Norris Joke: $Joke"

README.md

@@ -1,2 +1,30 @@
-# FreeChuckNorrisJoke
-My module for bringing Chuck Norris jokes to the shell.
+# FreeChuckNorrisJokes
+I created a module for bringing Chuck Norris jokes to the shell.
+
+By installing this PowerShell, you can have a wonderful Chuck Norris jokes in the shell using the chucknorris.io API.
+
+## Prerequisites
+*   Think Chuck Norris is the strongest and greatest man that has ever lived!
+*   Powershell access on your computer
+*   Basic Knowledge of PowerShell and can install modules on your device
+
+## Installation
+1. Using the PowerShell Gallery
+    a. Open the shell as an administrator and type in the follow command "Install-Module -Name FreeChuckNorrisJokes -Scope CurrentUser
+2. Manual Installation
+   a. Clone the repository using Git or download the .Zip file
+   b. Expand the archived .Zip file
+   c. Open PowerShell as an administrator and navigate to the directory where the module you expanded is located. 
+   d. Run the following command "Import-Module -Name .\FreeChuckNorrisJokes.psm1"
+
+## Examples
+get-chucknorrisjoke
+    This command fetches a random Chuck Norris joke from the API and displays it in the console.
+get-chucknorrisjokebycategory
+    This command prompts the user to enter a category and fetches a random Chuck Norris joke from that category. If the user enters an invalid category, it will prompt them again until a valid category is provided.
+
+## License
+GPL-3.0 license
+
+###
+Contributors are welcomed.