From 8d247d0b4a342ca3857fe17d3a2559011042613b Mon Sep 17 00:00:00 2001
From: Balearica <admin@scribeocr.com>
Date: Sun, 8 Dec 2024 18:49:28 -0800
Subject: [PATCH] Update README.md

---
 README.md | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index dbbd8479..e43d445f 100644
--- a/README.md
+++ b/README.md
@@ -29,9 +29,7 @@ Video Real-time Recognition
   <a href="https://github.com/jeromewu/tesseract.js-video"><img alt="Tesseract.js Video" src="./docs/images/video-demo.gif"></a>
 </p>
 
-
-Tesseract.js wraps a [webassembly port](https://github.com/naptha/tesseract.js-core) of the [Tesseract](https://github.com/tesseract-ocr/tesseract) OCR Engine.
-It works in the browser using [webpack](https://webpack.js.org/), esm, or plain script tags with a [CDN](#CDN) and on the server with [Node.js](https://nodejs.org/en/).
+Tesseract.js works in the browser using [webpack](https://webpack.js.org/), esm, or plain script tags with a [CDN](#CDN) and on the server with [Node.js](https://nodejs.org/en/).
 After you [install it](#installation), using it is as simple as:
 
 ```javascript
@@ -72,6 +70,11 @@ npm install tesseract.js@3.0.3
 yarn add tesseract.js@3.0.3
 ```
 
+## Project Scope
+Tesseract.js aims to bring the [Tesseract](https://github.com/tesseract-ocr/tesseract) OCR engine (a separate project) to the browser and Node.js, and works by wrapping a [WebAssembly port](https://github.com/naptha/tesseract.js-core) of Tesseract.  This project does not modify core Tesseract features.  Most notably, **Tesseract.js does not support PDF files and does not modify the Tesseract recognition model to improve accuracy.**
+
+If your project requires features outside of this scope, consider the [Scribe.js library](https://github.com/scribeocr/scribe.js).  Scribe.js is an alternative library created to accommodate common feature requests that are outside of the scope of this repo.  Scribe.js includes improvements to the Tesseract recognition model and supports extracting text from PDF documents, among other features.  For more information see [Scribe.js vs. Tesseract.js](https://github.com/scribeocr/scribe.js/blob/master/docs/scribe_vs_tesseract.md).
+
 ## Documentation
 
 * [Workers vs. Schedulers](./docs/workers_vs_schedulers.md)
@@ -152,12 +155,6 @@ npm start
 The development server will be available at http://localhost:3000/examples/browser/basic-efficient.html in your favorite browser.
 It will automatically rebuild `tesseract.min.js` and `worker.min.js` when you change files in the **src** folder.
 
-### Online Setup with a single Click
-
-You can use Gitpod(A free online VS Code like IDE) for contributing. With a single click it will launch a ready to code workspace with the build & start scripts already in process and within a few seconds it will spin up the dev server so that you can start contributing straight away without wasting any time. 
-
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/naptha/tesseract.js/blob/master/examples/browser/basic-efficient.html)
-
 ### Building Static Files
 To build the compiled static files just execute the following:
 ```shell
@@ -165,6 +162,13 @@ npm run build
 ```
 This will output the files into the `dist` directory.
 
+### Run Tests
+**Always confirm the automated tests pass before submitting a pull request.**  To run the automated tests locally, run the following commands.
+```shell
+npm run lint
+npm run test
+```
+
 ## Contributors
 
 ### Code Contributors