@pivotshare/avails - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

bin/avails.js

@@ -12,2 +12,3 @@ #!/usr/bin/env node
   .command('merge', 'merge historical Avails into one')
+  .command('diff', 'diff two avails to create a new one')
   .parse(process.argv);

package.json

 {
   "name": "@pivotshare/avails",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Tool for parsing and generating EMA Avails",
@@ -5,0 +5,0 @@ "main": "./lib/avails.js",

README.md

@@ -8,8 +8,8 @@ avails -- tools for parsing and generating EMA Avails
 
-  `avails merge` [-i type] [-o type] [file ...]
+  `avails merge` [-i type] [-o type] file1 [file2 ...]
 
+  `avails diff` [-i type] [-o type] file1 file2
+
 ## DESCRIPTION
 
-Content Availability Metadata, or _avails_, is an Entertainment industry term for information about the time, location and business rules relating to offering a media asset, e.g. a movie or a television show.
-
 `avails convert` simply transforms avails from one format to another.
@@ -19,9 +19,11 @@
 
+`avails diff` will accept two avails, A and B, and return a new avails containing entries unique to B, without entries that exist in both A and B, and with entries that are only in A as _Full Delete_ entries.
+
 The following options are available:
 
   * `-i`, `--input` _<type>_:
-    Specify the format of input file: tsv, json, xlsx. Required.
+    Specify the format of input file: tsv, json, xlsx. Required. See [FORMATS]().
 
   * `-o`, `--output` _<type>_:
-    Specify the format of output file: tsv, json, xlsx. Required.
+    Specify the format of output file: tsv, json, xlsx. Required. See [FORMATS]().
 
@@ -31,2 +33,4 @@ * `-h`:
 
+See [BACKGROUND]() for more information regarding the Avails standard and this tool.
+
 ## FORMATS
@@ -47,2 +51,10 @@
 
+## BACKGROUND
+
+Content Availability Metadata, or _avails_, is an Entertainment industry term for information about the time, location and business rules relating to offering a media asset, e.g. a movie or a television show.
+
+_avails_ document the transition between states, e.g. _Full Extract_, _Full Delete_, not states themselves, however, by manipulating initial and subsequent avails we can recreate the expected state of content on a given platform. This is the technique utilized by the `merge` and `diff` subcommands, and third-party tools that generate initial avails.
+
+It is recommended to persist submitted avails and use `avails`, together with custom or third-party tools, to easily create new avails, or determine state of content on third-party platforms.
+
 ## EXAMPLES
@@ -49,0 +61,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1078196

increased by0.68%

Number of package files

57

increased by7.55%

Lines of code

3975

increased by4.96%

Number of lines in readme file

79

increased by17.91%

Worsened metrics

Number of low supply chain risk alerts

10

increased by11.11%

No dependency changes