Skip to content

Commit

Permalink
chore: add imgcat example
Browse files Browse the repository at this point in the history
  • Loading branch information
moul committed Sep 5, 2018
1 parent a7371be commit 6607f30
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<a href="https://circleci.com/gh/moul/depviz">
<img src="https://circleci.com/gh/moul/depviz.svg?style=shield"
alt="Build Status">
</a>
</a>
<a href="https://goreportcard.com/report/moul.io/depviz">
<img src="https://goreportcard.com/badge/moul.io/depviz"
alt="Go Report Card">
Expand All @@ -31,7 +31,7 @@
</p>

<p align="center"><b>
<a href="https://moul.io/depviz">Website</a> •
<a href="https://moul.io/depviz">Website</a> •
<a href="https://twitter.com/moul">Twitter</a>
</b></p>

Expand All @@ -56,12 +56,26 @@ _inspired by this discussion: [jbenet/random-ideas#37](https://github.com/jbenet

```console
$ export GITHUB_TOKEN=xxxx

# render and display the roadmap
$ depviz render --repos=moul/depviz | dot -Tpng > depviz-roadmap.png
$ open depviz-roadmap.png

# render and display the orphans
$ depviz render --repos=moul/depviz -t orphans | dot -Tpng > depviz-orphans.png
$ open depviz-orphans.png
```

### Preview image withing iterm2

```console
# install imgcat
$ go get github.com/olivere/iterm2-imagetools/cmd/imgcat
$ depviz render | dot -Tpng | imgcat
```

![](https://raw.githubusercontent.com/moul/depviz/master/examples/imgcat.png)

## License

Apache
Binary file added examples/imgcat.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 6607f30

Please sign in to comment.