README.md in lapidarius-2.1.2 vs README.md in lapidarius-3.1.0
- old
+ new
@@ -4,12 +4,11 @@
* [Alternatives](#alternatives)
* [gem dep](#gem-dep)
* [bundle viz](#bundle-viz)
* [Usage](#usage)
* [Warning](#warning)
- * [Unique dependencies](#unique-dependencies)
- * [Recursive print](#recursive-print)
+ * [Output](#output)
## Scope
This gem is aimed to list recursively the **runtime dependencies** footprint of the specified gem.
### Alternatives
@@ -24,45 +23,22 @@
## 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 for their own dependencies, no remote fetching is performed.
+Consider only the gems installed on your system are scanned.
+No remote fetching is performed.
-### Unique dependencies
-The command outcome includes all of the unique (by name) nested runtime dependencies:
+### 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:
```
-$ lapidarius --gem=grape
+$ lapidarius --gem=sinatra
+sinatra (2.0.0)
+├── mustermann (~> 1.0)
+├── rack (~> 2.0)
+├── rack-protection (= 2.0.0)
+│ └── rack (>= 0)
+└── tilt (~> 2.0)
-grape (1.0.1) 16
-------------------------------
-activesupport (>= 0)
-builder (>= 0)
-mustermann-grape (~> 1.0.0)
-rack (>= 1.3.0)
-rack-accept (>= 0)
-virtus (>= 1.0.0)
-i18n (~> 0.7)
-minitest (~> 5.1)
-thread_safe (>= 0.3.4, ~> 0.3)
-tzinfo (~> 1.1)
-mustermann (~> 1.0.0)
-axiom-types (~> 0.1)
-coercible (~> 1.0)
-descendants_tracker (>= 0.0.3, ~> 0.0)
-equalizer (>= 0.0.9, ~> 0.0)
-ice_nine (~> 0.11.0)
-```
-
-### Recursive print
-To print dependencies hierarchy recursively, provide the *--recursive* flag. Duplicates are not counted:
-```
-$ lapidarius --gem=sinatra --recursive
-
-sinatra (1.4.7) 3
-------------------------------
-rack (~> 1.5)
-rack-protection (~> 1.4)
- rack (>= 0)
-tilt (< 3, >= 1.3)
-
+4 runtime dependencies
```