README.md in lapidarius-3.1.0 vs README.md in lapidarius-3.1.1
- old
+ new
@@ -2,16 +2,16 @@
* [Scope](#scope)
* [Alternatives](#alternatives)
* [gem dep](#gem-dep)
* [bundle viz](#bundle-viz)
+* [Warning](#warning)
* [Usage](#usage)
- * [Warning](#warning)
- * [Output](#output)
## Scope
-This gem is aimed to list recursively the **runtime dependencies** footprint of the specified gem.
+This gem is aimed to recursively collect the `runtime dependencies` footprint of the specified gem.
+The output of the library mimics the `tree` shell utility, highlighting the nested dependencies via ASCII characters.
### Alternatives
Some alternatives exists:
#### gem dep
@@ -19,19 +19,17 @@
#### bundle viz
The *bundle viz* command relies on the Gemfile and the [graphviz](http://www.graphviz.org/) library to generate a visual representation of the gem inter-dependencies.
While it is great to visualize inter-dependencies, i have hard times figuring out gem's runtime footprint.
-## Usage
-The library relies on the *Gem::Commands::DependencyCommand* class (the one invoked by the *gem dep* command line), invoking it recursively to deeply fetch dependencies.
-
-### Warning
-Consider only the gems installed on your system are scanned.
+## Warning
+Consider only the gems installed on your system are scanned by the library.
No remote fetching is performed.
-### Output
-The output of the library mimics the `tree` shell utility that lists file system nested entries.
-Although all of the nested runtime dependencies are included in the output, just the unique ones are counted:
+## Usage
+This library invokes the `Gem::Commands::DependencyCommand` class recursively to collect all the levels of dependency.
+Identical dependencies are counted just once:
+
```
$ lapidarius --gem=sinatra
sinatra (2.0.0)
├── mustermann (~> 1.0)
├── rack (~> 2.0)