Adds documentation for ellipse and square shapes (#2)

simonbs · Dec 12, 2022 · e9bb860 · e9bb860
1 parent 9867cdd
commit e9bb860
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -10,6 +10,8 @@ The graph below shows the relationship of the products and targets in this packa
 
 <img width="400" src="./sample-swift-package.png" alt="Example graph showing the dependencies of this package." />
 
+Nodes shaped as an ellipse represent products, e.g. the libraries in a Swift package, and the square nodes represent targets.
+
 ## 🚀 Getting Started
 
 Start off by installing the tool with [Homebrew](https://brew.sh).

diff --git a/Sources/Main/DependencyGraph.swift b/Sources/Main/DependencyGraph.swift
@@ -29,7 +29,11 @@ Valid values are:
     var rankSpacing: Float?
 
     static let configuration = CommandConfiguration(
-        abstract: "Generates graphs of the dependencies in an Xcode project or Swift package.",
+        abstract: """
+Generates graphs of the dependencies in an Xcode project or Swift package.
+
+Nodes shaped as an ellipse represent products, e.g. the libraries in a Swift package, and the square nodes represent targets.
+""",
         version: "1.0.0"
     )