README.md in graphwerk-1.0.0 vs README.md in graphwerk-1.1.0
- old
+ new
@@ -6,35 +6,35 @@
The gem builds on top of [Packwerk](https://github.com/Shopify/packwerk) and [Graphviz](https://github.com/glejeune/Ruby-Graphviz).
Here's an example application package dependency diagram:
-
+
## Install
Add this line to your application's Gemfile and run `bundle install`:
-`gem 'graphwerk'`
+`gem 'graphwerk', group: %i[development test]`
## Usage
For Rails applications a Railtie automatically loads a rake task that makes it easy to generate a diagram for your root package and its dependencies. The diagram will be placed at the root of your application as `packwerk.png`.
```bash
bundle exec rake graphwerk:update
```
-More advance usage is possible by passing a `Packwerk::PackageSet` directly to `Graphwerk::Builders::Graph` and calling `#build` returning a `Graphviz` instance:
+More advance usage is possible by passing a [`Packwerk::PackageSet`](https://github.com/Shopify/packwerk/blob/main/lib/packwerk/package_set.rb) directly to `Graphwerk::Builders::Graph` and calling `#build` returning a `Graphviz` instance:
```ruby
graph = Graphwerk::Builders::Graph.new(
Packwerk::PackageSet.load_all_from(".")
).build
graph.output(svg: 'packwerk.svg')
```
-All Graphviz layouts are supported and options for the graph, nodes and edges can be set via an optional `options` argument:
+All [Graphviz layouts](https://graphviz.org/documentation/#layout-manual-pages) are supported and options for the graph, nodes and edges can be set via an optional `options` argument:
```ruby
graph = Graphwerk::Builders::Graph.new(
Packwerk::PackageSet.load_all_from("."),
options: {