Skip to content

Commit 9926868

Browse files
committed
doc: Update readme
1 parent 666d6ac commit 9926868

1 file changed

Lines changed: 9 additions & 13 deletions

File tree

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# StackTower
22

3-
Traditional dependency graphs are hairballs—nodes and edges sprawling in every direction. StackTower renders them as **layered towers** that reveal structure at a glance:
3+
Inspired by [XKCD #2347](https://xkcd.com/2347/), StackTower renders dependency graphs as **physical towers** where blocks rest on what they depend on. Your application sits at the top, supported by libraries below—all the way down to that one critical package maintained by *some dude in Nebraska*.
44

5-
- **Width = Importance** — Packages supporting more of your code get more visual weight
6-
- **Depth = Foundation** — See what's at the bottom of your stack
7-
- **No Crossings** — Optimal ordering eliminates the spaghetti
5+
Traditional node-link diagrams are technically correct but don't *feel* like anything. Tower visualizations tap into intuition: width shows importance, depth reveals foundation, and the structure makes hidden dependencies visible at a glance.
86

9-
The result: you can finally *see* your dependency structure instead of deciphering it.
10-
11-
📖 **[Interactive examples at stacktower.io](https://www.stacktower.io)**
7+
📖 **[Read the full story at stacktower.io](https://www.stacktower.io)**
128

139
## Quick Start
1410

@@ -35,13 +31,13 @@ StackTower works in two stages: **parse** dependency data from package registrie
3531

3632
```bash
3733
# Python (PyPI)
38-
stacktower parse python requests -o requests.json
34+
stacktower parse python fastapi -o fastapi.json
3935

4036
# Rust (crates.io)
4137
stacktower parse rust serde -o serde.json
4238

4339
# JavaScript (npm)
44-
stacktower parse javascript express -o express.json
40+
stacktower parse javascript yup -o yup.json
4541
```
4642

4743
Add `--enrich` with a `GITHUB_TOKEN` to pull repository metadata (stars, maintainers, last commit) for richer visualizations.
@@ -50,13 +46,13 @@ Add `--enrich` with a `GITHUB_TOKEN` to pull repository metadata (stars, maintai
5046

5147
```bash
5248
# Tower visualization (recommended)
53-
stacktower render graph.json -t tower -o tower.svg
49+
stacktower render fastapi.json -t tower -o fastapi.svg
5450

5551
# Hand-drawn style with hover popups
56-
stacktower render graph.json -t tower --style handdrawn --popups -o tower.svg
52+
stacktower render serde.json -t tower --style handdrawn --popups -o serde.svg
5753

5854
# Traditional node-link diagram
59-
stacktower render graph.json -o nodelink.svg
55+
stacktower render yup.json -t nodelink -o yup.svg
6056
```
6157

6258
### Included Examples
@@ -67,7 +63,7 @@ The repository ships with pre-parsed graphs so you can experiment immediately:
6763
# Real packages with full metadata
6864
stacktower render examples/real/flask.json -t tower --style handdrawn --merge -o flask.svg
6965
stacktower render examples/real/serde.json -t tower --popups -o serde.svg
70-
stacktower render examples/real/express.json -t tower -o express.svg
66+
stacktower render examples/real/express.json -t tower --ordering barycenter -o express.svg
7167

7268
# Synthetic test cases
7369
stacktower render examples/test/diamond.json -t tower -o diamond.svg

0 commit comments

Comments
 (0)