Merge pull request #4 from internetarchive/webcomponent

Add README for the Web Component

Author: ibnesayeed

.github/workflows/npm_dist.yml

@@ -20,6 +20,6 @@ jobs:
           node-version: "16.x"
           registry-url: "https://registry.npmjs.org"
       - name: Publish package on NPM
-        run: npm publish --access public webcomponent
+        run: cd webcomponent && npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_PASSWORD }}

webcomponent/README.md

@@ -0,0 +1,13 @@
+# CDX Summary Web Component
+
+Assuming that a CDX Summary JSON file is generated from CDX files or WARC collections using the `cdxsummary` [CLI tool](https://github.com/internetarchive/cdx-summary), use the following Web Component to render it as an interactive HTML markup.
+
+```html
+<cdx-summary src="CDX_SUMMARY_JSON_URL"></cdx-summary>
+```
+
+Alternatively, render a summary from a `web` collection/item of Internet Archive's Petabox, if a corresponding summary file is generated already.
+
+```html
+<cdx-summary item="PETABOX_ITEM_OR_COLLECTION_ID"></cdx-summary>
+```