From 99ad0477ba58d78f5608f9bf3d9459a655a91b4e Mon Sep 17 00:00:00 2001
From: Phillip Webb <phil.webb@broadcom.com>
Date: Tue, 19 Mar 2024 10:06:55 -0700
Subject: [PATCH] Add README for npm

---
 package.json                                |  4 +---
 packages/antora-xref-extension/README.adoc  | 10 ++++++++++
 packages/antora-xref-extension/package.json |  4 ++++
 3 files changed, 15 insertions(+), 3 deletions(-)
 create mode 100644 packages/antora-xref-extension/README.adoc

diff --git a/package.json b/package.json
index 4519d63..c0b76ff 100644
--- a/package.json
+++ b/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"
diff --git a/packages/antora-xref-extension/README.adoc b/packages/antora-xref-extension/README.adoc
new file mode 100644
index 0000000..fd3fd05
--- /dev/null
+++ b/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.
diff --git a/packages/antora-xref-extension/package.json b/packages/antora-xref-extension/package.json
index 2c0b3bf..a7207e5 100644
--- a/packages/antora-xref-extension/package.json
+++ b/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"