aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authorSteve Winslow <swinslow@gmail.com>2018-12-06 13:39:20 +0900
committerSteve Winslow <swinslow@gmail.com>2018-12-06 13:39:20 +0900
commitc7f466f2e6a0afb7a52546fb5ab6b248e024e7bd (patch)
tree4cf99e5d9746d8409b5b454d575a4520f942d82c /examples/README.md
parentfe644adc096ddbc14cd4b797aea3a5890a3d0a02 (diff)
downloadspdx-tools-c7f466f2e6a0afb7a52546fb5ab6b248e024e7bd.tar.gz
Added example for licensediff
Signed-off-by: Steve Winslow <swinslow@gmail.com>
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
index 64e41f2..19a58b9 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -42,3 +42,14 @@ Package and File license fields; and saving the resulting document to disk.
This example demonstrates loading an SPDX tag-value file from disk into memory,
generating a basic report listing counts of the concluded licenses for its
files, and printing the report to standard output.
+
+## 6-licensediff
+
+*licensediff*, *tvloader*
+
+This example demonstrates loading two SPDX tag-value files from disk into
+memory, and generating a diff of the concluded licenses for Files in the
+first-listed Packages in each document.
+
+This is generally only useful when run with two SPDX documents that describe
+licenses for subsequent versions of the same set of files.