From cb37a37f27fe08850dcea0bf30df78f5ebd4610e Mon Sep 17 00:00:00 2001
From: Daniel Bauer <4690162+dnlbauer@users.noreply.github.com>
Date: Sun, 27 Nov 2022 13:52:16 +0100
Subject: [PATCH] Update README.md

---
 README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 19fc3b6..d0b0048 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
 # pdfact-service
-Analyze pdf files with pdfact using a simple web API
+[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)
+[![Docker](https://img.shields.io/docker/cloud/build/eaudeweb/scratch?label=Docker&style=flat)](https://hub.docker.com/r/dnlbauer/pdfact-service/tags)
+
+A Webservice to analyze the content of PDF Documents using a HTTP API. This is a simple HTTP wrapper around [ad-freiburg/pdfact](https://github.com/ad-freiburg/pdfact) and builds the container image directly from their source.
+
+## Usage
+Start the service:
+```bash
+> docker run -p 80:80 dnlbauer/pdfact-service
+
+[2022-11-27 12:36:38 +0000] [1] [INFO] Starting gunicorn 20.1.0
+[2022-11-27 12:36:38 +0000] [1] [INFO] Listening at: http://0.0.0.0:80 (1)
+[2022-11-27 12:36:38 +0000] [1] [INFO] Using worker: gthread
+[2022-11-27 12:36:38 +0000] [7] [INFO] Booting worker with pid: 7
+```
+
+PDFs can be `POST`ed to `/analyze` as multipart file request. The response will contain the output of `pdfact`. The response format can be specified using the correct MIME `Accept` header; `pdfact` van provide json, xml and plain text as output format.
+
+```bash
+> curl -H "Accept: application/json" -F file=@testfile.pdf localhost:80/analyze
+
+{"paragraphs": [
+  {"paragraph": {
+    "role": "page-header",
+    "positions": [{
+      "minY": 642.6,
+      "minX": 210.3,
+      "maxY": 652.6,
+      "maxX": 401.6,
+      "page": 1
+    }],
+    "text": "This is a test PDF document."
+  }},
+  {"paragraph": {
+    "role": "body",
+    "positions": [{
+      "minY": 628.5,
+      "minX": 91.2,
+      "maxY": 636.6,
+      "maxX": 520.8,
+      "page": 1
+    }],
+    "text": "If you can read this, you are lucky."
+  }}
+]}
+```
+
+## Thanks
+All credits go to the Algorithms and Data Structures Group from University of Freiburg for [ad-freiburg/pdfact](https://github.com/ad-freiburg/pdfact).