readme update

Author: jozefbaranec

README.md

@@ -1,57 +1,69 @@
-# Validate PDF Accessibility with PDFix
+# PDF Accessibility Validator using PDFix
+A Java CLI tool for validating accessibility issues in PDF documents
 
-A Java CLI application to validate and report accessibility issues in PDF documents. We use free version of PDFix SDK for PDF reading operations.
+## Introduction
+This tool validates PDF accessibility by checking for issues in tagged PDF documents. It leverages the PDFix SDK (free version) for reading and processing PDF files. Ensuring that PDFs are accessible is crucial for users with disabilities, and this tool helps identify and report potential issues.
 
 ## Table of Contents
-- [Validate PDF Accessibility with PDFix](#validate-pdf-accessibility-with-pdfix)
+- [PDF Accessibility Validator using PDFix](#pdf-accessibility-validator-using-pdfix)
+  - [Introduction](#introduction)
   - [Table of Contents](#table-of-contents)
-  - [Command-Line options](#command-line-options)
+  - [Command-Line Options](#command-line-options)
   - [Run the CLI Commands](#run-the-cli-commands)
     - [Report Duplicate MCID in Tagged PDF](#report-duplicate-mcid-in-tagged-pdf)
+  - [Installation](#installation)
   - [Build Instructions](#build-instructions)
     - [1. Download and Install PDFix SDK for Java](#1-download-and-install-pdfix-sdk-for-java)
     - [2. Compile, Test and Package](#2-compile-test-and-package)
   - [Have a question? Need help?](#have-a-question-need-help)
 
 
-## Command-Line options
-```
+## Command-Line Options
+```yml
 Usage:
-  java -jar validate-pdf-1.0.0.jar [operation] [arguments]
+  java -jar validate-pdf-{version}.jar [operation] [arguments]
 
 Operations:
-  duplicate-mcid    : Validate and report duplicate MCID entries in a tagged content
+  duplicate-mcid    : Check for and report duplicate MCID (Marked Content Identifier) entries in a tagged PDF.
 
 Arguments:
-  -i <file>         : Path to a PDF file to process
-  -d <folder>       : Path to a directory to process
+  -i <file>         : Path to a single PDF file to validate.
+  -d <folder>       : Path to a directory of PDF files to validate (will process all PDFs in the folder).
 ```
 
 ## Run the CLI Commands
 
 ### Report Duplicate MCID in Tagged PDF
+This command validates a PDF file for duplicate MCID entries, which can cause accessibility issues for screen readers.
+
 ```bash
-java -jar target/net.pdfix.validate-pdf-1.0.0 duplicate-mcid -i "<path to pdf>"
+java -jar target/net.pdfix.validate-pdf-{version}.jar duplicate-mcid -i "path/to/your/file.pdf"
 ```
+
 **Output**
-```
+```yaml
 ===============================================================================
-File: /Users/administrator/Downloads/example.pdf
+File: path/to/your/file.pdf
 Duplicate MCID Found:
   MCID      : 9
   Page      : 26
   Index     : 32
   Type      : text
   BBox      : [240.12, 455.95, 297.72, 457.32]
-  Content: Freitag
+  Content   : Friday
 
-Total 1 duplicate MCIDs found  
+Total 1 duplicate MCID(s) found  
 ===============================================================================
 ```
 
+## Installation
+You can download the pre-built `jar` from the [Releases page](https://github.com/pdfix/action-validate-pdf-pdfix-java/releases) if you prefer not to build the tool yourself.
+
 ## Build Instructions
 
 ### 1. Download and Install PDFix SDK for Java
+Before building the project, you need to download and install the PDFix SDK. This SDK is used to read and process PDF files for accessibility validation. Run the following commands:
+
 ```bash
 mkdir -p lib
 curl -L https://github.com/pdfix/pdfix_sdk_builds/releases/download/v8.4.3/java8-net.pdfix.pdfixlib-8.4.3.jar.zip -o lib/pdfixlib-8.4.3.jar.zip
@@ -66,7 +78,5 @@ mvn test
 mvn package
 ```
 
-
-
 ## Have a question? Need help?
-Let us know and we’ll get back to you. Write us to [email protected].
+If you have any questions or need assistance, feel free to reach out to us via email at [[email protected]](mailto:[email protected]).

src/main/java/net/pdfix/App.java

@@ -78,7 +78,7 @@ private static void processFile(File file) throws Exception {
     if (count == 0) {
       System.out.println("No duplicate MCIDs found");
     } else {
-      System.out.println(String.format("Total %d duplicate MCIDs found", count));
+      System.out.println(String.format("Total %d duplicate MCID(s) found", count));
     }
   }