Skip to content

Commit 749b31f

Browse files
committed
updated README.md with new license, examples, contribution guidelines, install instrructions, etc
1 parent 4d60221 commit 749b31f

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,46 @@
11
# FreeDadJokes
2-
Get Dad Jokes on the PowerShell Command Line!
2+
Get Dad Jokes on the PowerShell Command Line!
3+
4+
By installing this PowerShell module, you'll be able to scale stupid jokes at a scale that was never possible before!
35

46
## Prerequisites
7+
- Paternity test:
8+
- Be a dad.
9+
- Have a dad (biological, step dad or otherwise).
10+
- Powershell access:
11+
- Have Powershell available on your machine (Windows, MacOS or Linux).
12+
- Basic Knowledge:
13+
- Familiarity with PowerShell.
14+
- Access to install modules locally.
15+
516
## Installation
17+
18+
There are two ways to install the `FreeDadJokes` module:
19+
20+
1. **Using PowerShell Gallery**
21+
- Open PowerShell as an administrator and run the following command to install the module from the PowerShell Gallery:
22+
```powershell
23+
Install-Module -Name FreeDadJokes -Scope CurrentUser
24+
```
25+
2. **Manual Installation**
26+
- Clone this repository using Git or download the ZIP file.
27+
- Extract the contents of the ZIP file to a directory on your computer.
28+
- Open PowerShell as an administrator and navigate to the directory where you extracted the module files.
29+
- Run the following command to install the module:
30+
31+
```powershell
32+
Import-Module -Name .\FreeDadJokes.psm1
33+
```
34+
Note that the manual installation method requires you to have Git installed on your computer, as well as the ability to extract ZIP files. If you do not have these tools installed, you can use the PowerShell Gallery method instead.
35+
36+
637
## Usage
38+
739
### Examples
40+
```powershell
41+
Get-DadJoke
42+
```
43+
This command will return two lines of output. The leadup, and the joke.
844

945
## License
1046

0 commit comments

Comments
 (0)