Add README for npm

package.json

@@ -15,9 +15,7 @@
     "format": "node npm/format.js packages/${npm_config_package},npm",
     "lint": "eslint \"{docs,npm}/**/*.js\" \"packages/${npm_config_package:-*}/{lib,test}/**/*.js\"",
     "test": "_mocha",
-    "version": "node npm/version.js",
-    "postpublish": "downdoc --postpublish",
-    "prepublishOnly": "downdoc --prepublish"
+    "version": "node npm/version.js"
   },
   "engines": {
     "node": ">=16.0.0"

packages/antora-xref-extension/README.adoc

@@ -0,0 +1,10 @@
+= Antora Xref Extension
+
+The Antora Xref Extension augments Antora's support for xref macros with the following features:
+
+* Validate that the target file contains an anchor that matches the fragment.
+* Use default link text from the title or `reftext` of the target.
+* Stub links that don't yet exist
+* Produce warnings if link text is unnecessary 
+
+See https://github.com/spring-io/antora-xref-extension/ for more details and usage instructions.

packages/antora-xref-extension/package.json

@@ -12,6 +12,10 @@
     "bugs": {
         "url": "https://github.com/spring-io/antora-xref-extension/issues"
     },
+    "scripts": {
+        "postpublish": "downdoc --postpublish",
+        "prepublishOnly": "downdoc --prepublish"
+    },
     "main": "lib/index.js",
     "exports": {
         ".": "./lib/index.js"