From 38d12d91c195231fde521aa3da0c7a78eb4a517c Mon Sep 17 00:00:00 2001
From: Andy Bunce <bunce.andy@gmail.com>
Date: Tue, 4 Feb 2025 16:09:34 +0000
Subject: [PATCH] [mod] docs

---
 .gitea/workflows/ci-basex.yaml   |  6 ++++--
 .gitea/workflows/trigger/release |  2 +-
 README.md                        | 22 +++++++++++++---------
 3 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/.gitea/workflows/ci-basex.yaml b/.gitea/workflows/ci-basex.yaml
index 2e4747b..c67f4d3 100644
--- a/.gitea/workflows/ci-basex.yaml
+++ b/.gitea/workflows/ci-basex.yaml
@@ -42,12 +42,14 @@ jobs:
 
     - name: Checkout repository
       uses: actions/checkout@v4
-
+      with:
+        ref: main
+        
     - name: Build package
       run: |
         basex scripts/install.bxs
       
-    - name: run tests
+    - name: Run tests
       run: |
         basex -Wt src/test
 
diff --git a/.gitea/workflows/trigger/release b/.gitea/workflows/trigger/release
index 31d2785..b7aa45e 100644
--- a/.gitea/workflows/trigger/release
+++ b/.gitea/workflows/trigger/release
@@ -1,4 +1,4 @@
 30/1/2025.................
 ..lgnfjfggfgxhcsxwnndccxcxx
 c
-Xy
\ No newline at end of file
+Xyx
\ No newline at end of file
diff --git a/README.md b/README.md
index e8bb31e..1faa1cd 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,19 @@
 # Pdfbox
-BaseX (10+) interface to [Pdfbox](https://pdfbox.apache.org/) version 3
-
+A BaseX interface for [Pdfbox](https://pdfbox.apache.org/) version 3. 
+It is packaged using the [Expath](https://docs.basex.org/main/Repository#expath_packaging) format, and is tested against BaseX 10.7 and 11.7
 ## Features
-* read page count
-* read outline
-* read pagelabels
-* read page text
-* save pdf page range to new pdf
-* save pdf page as image
+* read PDF page count.
+* read any PDF outline and return as maps or XML.
+* read pagelabels.
+* read page text.
+* save pdf page range to a new pdf.
+* save pdf page as an image.
 
 
 ## Build
 
-Use `scripts/make-fat-jar.xq` to package the required `jar`s and `xqm` files to the `dist` folder.
+* `scripts/make-xar.xq` packages the required `jar`s and `xqm` files to a `xar` file in the `dist` folder.
+
+### Action support
+
+The workflow `ci-basex.yaml` builds and tests the package. This can be used as an action on [github](https://github.com/features/actions), or on a local [gitea](https://docs.gitea.com/usage/actions/overview) installation.