From 4b4cdb85ff61bc55c29ef29a2d07e792db11d2ba Mon Sep 17 00:00:00 2001
From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com>
Date: Sat, 6 May 2023 16:10:06 +0100
Subject: [PATCH] documentation

---
 HowToUseOCR.md |  4 ++--
 README.md      | 34 ++++++++++++++++++++++++++++------
 build.gradle   |  2 +-
 3 files changed, 31 insertions(+), 9 deletions(-)

diff --git a/HowToUseOCR.md b/HowToUseOCR.md
index 9a867cbb..b015f53d 100644
--- a/HowToUseOCR.md
+++ b/HowToUseOCR.md
@@ -34,14 +34,14 @@ services:
   your_service_name:
     image: your_docker_image_name
     volumes:
-      - /usr/share/tesseract-ocr/4.00/tessdata:/location/of/trainingData
+      - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata
 ```
 
 
 #### Docker run
 Add the following to your existing docker run command
 ```bash
--v /usr/share/tesseract-ocr/4.00/tessdata:/location/of/trainingData
+-v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata
 ```
 
 #### Non-Docker
diff --git a/README.md b/README.md
index b5264c07..a2bc9003 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,10 @@ Feel free to request any features or bug fixes either in github issues or our [D
 - Merge multiple PDFs together into a single resultant file
 - Convert PDFs to and from images
 - Reorganize PDF pages into different orders.
-- Add images to PDFs at specified locations. (WIP)
+- Add/Generate signatures
+- Flatten PDFs
+- Repair PDFs
+- Add images to PDFs
 - Rotating PDFs in 90 degree increments.
 - Compressing PDFs to decrease their filesize. (Using OCRMyPDF)
 - Add and remove passwords
@@ -35,6 +38,7 @@ Feel free to request any features or bug fixes either in github issues or our [D
 - Dark mode support.
 - Custom download options (see [here](https://github.com/Frooodle/Stirling-PDF/blob/main/images/settings.png) for example)
 - Parallel file processing and downloads
+- API for integration with external scripts 
 
 ## Technologies used
 - Spring Boot + Thymeleaf
@@ -64,16 +68,34 @@ https://hub.docker.com/r/frooodle/s-pdf
 
 Docker Run
 ```
-docker run -p 8080:8080 frooodle/s-pdf
+docker run -d \
+  -p 8080:8080 \
+  -v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata \
+  --name stirling-pdf \
+  frooodle/s-pdf
+  
+  
+  Can also add these for customisation
+  -e APP_HOME_NAME="Stirling PDF" \
+  -e APP_HOME_DESCRIPTION="Your locally hosted one-stop-shop for all your PDF needs." \
+  -e APP_NAVBAR_NAME="Stirling PDF" \
 ```
 Docker Compose
 ```
 version: '3.3'
 services:
-    s-pdf:
-        ports:
-            - '8080:8080'
-        image: frooodle/s-pdf
+  stirling-pdf:
+    image: frooodle/s-pdf
+    ports:
+      - '8080:8080'
+    volumes:
+      - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata #Required for extra OCR languages
+#      - /location/of/extraConfigs:/configs
+#    environment:
+#      APP_HOME_NAME: Stirling PDF
+#      APP_HOME_DESCRIPTION: Your locally hosted one-stop-shop for all your PDF needs.
+#      APP_NAVBAR_NAME: Stirling PDF
+
 ```
 
 
diff --git a/build.gradle b/build.gradle
index 76296dbc..719a63ae 100644
--- a/build.gradle
+++ b/build.gradle
@@ -5,7 +5,7 @@ plugins {
 }
 
 group = 'stirling.software'
-version = '0.7.0'
+version = '1.0.0'
 sourceCompatibility = '17'
 
 repositories {