Skip to content

Refresh docs: readme, PITCHME, docs/ pages, about_PSGraph help topic #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
exactmike merged 1 commit into from
Aug 31, 2026
Merged

Refresh docs: readme, PITCHME, docs/ pages, about_PSGraph help topic #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions PITCHME.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

PSGraph is a PowerShell module that lets you script the generation of graphs using the GraphViz engine. It makes it easy to produce data-driven visualizations straight from PowerShell objects.

![basic graph](images/firstGraph.png)
![basic graph](docs/images/firstGraph.png)

---
### Install PSGraph from the PowerShell Gallery
Expand Down Expand Up @@ -38,7 +38,7 @@ Then we can render the graph as an image.
Edge -From middle -To end
} | Export-PSGraph -ShowGraph

![firstGraph](images/firstGraph.png)
![firstGraph](docs/images/firstGraph.png)

---

Expand All @@ -64,7 +64,7 @@ Describe how tiers of servers relate to each other.
edge AvailabilityGroup -To $DatabaseServer
} | Export-PSGraph -ShowGraph

![servers](images/pitchme-serverfarm.png)
![servers](docs/images/pitchme-serverfarm.png)

---

Expand All @@ -89,7 +89,7 @@ Describe how tiers of servers relate to each other.
Edge 'Orders:CustomerId' -To 'Customers:Id'
} | Export-PSGraph -ShowGraph

![schema](images/pitchme-schema.png)
![schema](docs/images/pitchme-schema.png)

---

Expand All @@ -114,7 +114,7 @@ Graph what's actually running right now, color-coded by memory use via `New-Node
edge $procs -FromScript {$_.Parent.Id} -ToScript {$_.Id}
} | Export-PSGraph -ShowGraph

![process tree](images/pitchme-processtree.png)
![process tree](docs/images/pitchme-processtree.png)

---

Expand All @@ -131,7 +131,7 @@ Graph what's actually running right now, color-coded by memory use via `New-Node
}
} | Export-PSGraph -ShowGraph

![service dependencies](images/pitchme-servicedeps.png)
![service dependencies](docs/images/pitchme-servicedeps.png)

---

Expand All @@ -148,7 +148,7 @@ Dogfooding: walk installed modules' own `RequiredModules` and graph them.
}
} | Export-PSGraph -ShowGraph

![module dependencies](images/pitchme-moduledeps.png)
![module dependencies](docs/images/pitchme-moduledeps.png)

---

Expand All @@ -162,13 +162,13 @@ Dogfooding: walk installed modules' own `RequiredModules` and graph them.
$dot | pngGraph -Destination out.png
$dot | pdfGraph -Destination out.pdf

![formats](images/pitchme-formats.png)
![formats](docs/images/pitchme-formats.png)

---

### More examples

* [Project structure](images/filesSmall.png) — a folder tree walked with `Get-ChildItem`
* [Project structure](docs/images/filesSmall.png) — a folder tree walked with `Get-ChildItem`
* [GraphViz gallery recreations](https://github.com/themodulecollective/PSGraph/blob/main/docs/Example-Gallery.md) — clusters, entity-relation diagrams, finite automata
* Full command reference and more scripted examples: [psgraph.readthedocs.io](http://psgraph.readthedocs.io)

Expand Down
Loading