Skip to content

Commit

Permalink
Add images to README.md to show cmdlet output.
Browse files Browse the repository at this point in the history
This commit adds some example output to the README.md, in image format.
This will let prospective users actually see what this module does.

I would have used something smaller than PNG files, but Markdown does
not have anything like the <source> tag.
  • Loading branch information
rhymeswithmogul committed Apr 24, 2024
1 parent 79733de commit 7b4dad4
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Exchange Online always uses DKIM selectors "selector1" and "selector2". If a do
```powershell
PS C:\> Test-MailPolicy fabrikam.com -DkimSelectorsToCheck "selector1","selector2"
```
![MailPolicyExplainer's output when running: Test-MailPolicy -DkimSelectorsToCheck 'selector1','selector2' microsoft.com](https://raw.githubusercontent.com/rhymeswithmogul/MailPolicyExplainer/main/man/en-US/Microsoft.com.png)

But what if they *do* use something like Constant Contact? Assuming the DKIM selector name is known:
```powershell
Expand All @@ -48,6 +49,9 @@ Or, if you only want to test one aspect of email, you can test items individuall
PS C:\> Test-MtaStsPolicy adatum.com
```

![MailPolicyExplainer's output when running: Test-MaStsPolicy colincogle.name](https://raw.githubusercontent.com/rhymeswithmogul/MailPolicyExplainer/main/man/en-US/MyMtaSts.png)


## SPF DNS Lookup Counts
It can also count how many DNS lookups are in an SPF record.
```powershell
Expand All @@ -56,6 +60,8 @@ PS C:\> Test-SpfRecord northwindtraders.com -CountDnsLookups # or
PS C:\> Test-SpfRecord northwindtraders.com -Recurse
```

![MailPolicyExplainer's output when running: Test-SpfRecord -Recurse microsoft.com](https://raw.githubusercontent.com/rhymeswithmogul/MailPolicyExplainer/main/man/en-US/MicrosoftSPF.png)


# Further Help
For more help, why not start with [the conceptual help](https://github.com/rhymeswithmogul/MailPolicyExplainer/blob/main/man/en-US/about_MailPolicyExplainer.md)?
Binary file added man/en-US/Microsoft.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/en-US/MicrosoftSPF.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/en-US/MyMtaSts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7b4dad4

Please sign in to comment.