Update README for new FHIR Publisher config features (#216)

* Update README for new FHIR Publisher config features

(cherry picked from commit 5f81355)

* Upgrade shr-fhir-export to 6.1.0

* v6.2.0

README.md

@@ -125,6 +125,7 @@ The contents of the configuration file are as follows:
 |`filterStrategy`     |`{}`    |An object containing configuration for filtering.              |
 |`contentProfile`     |`string`|The base file name for the content profile for the project.    |
 |`implementationGuide`|`{}`    |An object containing configuration for IG publishing.          |
+|`copyrightYear`      |`string`|The copyright year to include in the documentation.            |
 |`publisher`          |`string`|The name of the publisher for the project.                     |
 |`contact`            |`[]`    |The array of FHIR `ContactPoint`s to reach about the project.  |
 
@@ -170,21 +171,27 @@ The contents of the `implementationGuide` object are as follows:
 |:-------------------------|:--------|:--------------------------------------------------------------------|
 |`npmName`                 |`string` |The assigned npm-name for this IG (usually assign by HL7).           |
 |`version`                 |`string` |The version of this IG (not necessarily the version of FHIR).        |
+|`ballotStatus`            |`string` |The ballot status of the IG (e.g., STU1 Ballot, CI Build, etc.)      |
 |`packageList`             |`string` |The name of the file to use as the package-list.json for publication.|
 |`includeLogicalModels`    |`boolean`|A value indicating whether to include logical models in the IG.      |
 |`includeModelDoc`         |`boolean`|A value indicating whether to include the model doc in the IG.       |
 |`indexContent`            |`string` |The name of the file or folder containing the IG index content.      |
+|`extraResources`          |`string` |The name of the folder containing extra JSON resources to include in the IG.|
 |`examples`                |`string` |The name of the folder containing examples to include in the IG.     |
+|`historyLink`             |`string` |The URL for the page containing the IG's history information.        |
+|`changesLink`             |`string` |The URL to a site where users can request changes (shown in footer)  |
 |`primarySelectionStrategy`|`{}`     |The strategy for selection of what is primary in the IG.             |
 
+The file indicated by `packageList` will be used as the `package-list.json` file for publication.  This file is required for all HL7 IGs.  If a `packageList` file is not indicated, it will default to `package-list.json`.  If a package file exists at the configured location, it will be used.  Otherwise, if the configured `fhirURL` is an hl7.org or fhir.org URL (indicating it is an HL7 publication), a basic package list file will be created.  In this case, the IG author should review and modify the file as needed and then check it into the version control system.  For more information about the `package-list.json` file, see: [http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco](http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco).
+
 If the `indexContent` value is a path to a folder (relative to the spec directory), then it should contain an `index.html` file whose contents will be used as the body of the IG landing page.
 
+The folder indicated by `extraResources` should include one file per JSON-formatted resource to include.  Currently, the following resource types are supported: `SearchParameter`, `OperationDefinition`, `CapabilityStatement` (STU3+), `Conformance` (DSTU2).  If files are detected, links are added to the navigation menu as necessary.
+
 The folder indicated by `examples` should include one file per JSON-formatted example.  Each example may be named as the author wishes, but we recommend the example name match the example `id` in the file (with a `.json` file extension added).  The example JSON must contain an `id` and the example's `meta.profile` should include the canonical URL for the profile it exemplifies (e.g., `"meta": { "profile": [ "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastCancerPresenceStatement" ] }`).
 
 _NOTE: For backwards compatibility, if no `examples` folder is specified in the config, and a folder named "fhir-examples" exists in the spec directory, it will be used as the examples folder._
 
-The file indicated by `packageList` will be used as the `package-list.json` file for publication.  This file is required for all HL7 IGs.  If a `packageList` file is not indicated, it will default to `package-list.json`.  If a package file exists at the configured location, it will be used.  Otherwise, if the configured `fhirURL` is an hl7.org or fhir.org URL (indicating it is an HL7 publication), a basic package list file will be created.  In this case, the IG author should review and modify the file as needed and then check it into the version control system.  For more information about the `package-list.json` file, see: [http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco](http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco).
-
 The contents of the `primarySelectionStrategy` object are as follows:
 
 |Parameter |Type    |Description                                                                                                 |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shr-cli",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Command-line interface for SHR tools",
   "author": "",
   "license": "Apache-2.0",
@@ -25,7 +25,7 @@
     "shr-data-dict-export": "^6.0.0",
     "shr-es6-export": "^6.0.0",
     "shr-expand": "^6.0.0",
-    "shr-fhir-export": "^6.0.1",
+    "shr-fhir-export": "^6.1.0",
     "shr-json-javadoc": "^6.0.0",
     "shr-json-schema-export": "^6.0.0",
     "shr-models": "^6.0.0",

yarn.lock

@@ -1273,10 +1273,10 @@ shr-expand@^6.0.0:
   resolved "https://registry.yarnpkg.com/shr-expand/-/shr-expand-6.0.0.tgz#a2072f971e19b9f221e012c0056ee389a78633d7"
   integrity sha512-zzjli5uVY23J4jHnr5Cr+iLkZ7+6RsHk3kQMksBPUR4ly96NXlCRgillJ3IszbdP3dHpBuWymcrAOjyz4C/lRA==
 
-shr-fhir-export@^6.0.1:
-  version "6.0.1"
-  resolved "https://registry.yarnpkg.com/shr-fhir-export/-/shr-fhir-export-6.0.1.tgz#2e54a1cab1ff49f937b529a1a95d0876cf4fd162"
-  integrity sha512-My2z/NP+Qqbysa/F8qKInx/DfmVsTLURKhOGR4dAucIEyIMYkMzFhMjhlSeTFoL9HaKfISmWzc3pvKur7/nYcQ==
+shr-fhir-export@^6.1.0:
+  version "6.1.0"
+  resolved "https://registry.yarnpkg.com/shr-fhir-export/-/shr-fhir-export-6.1.0.tgz#ff3dec2b4e047c369b54dd1206da7757af59bb32"
+  integrity sha512-kZtyeOfSKVPdwSewKabW5n1tCtHWKu7yemmPIfEFCd6NTqI8eD5LmTqZsst5rORcpUdmG2KeM27WC2Q1RxD7HQ==
   dependencies:
     fs-extra "^2.0.0"
     lodash "^4.17.5"