Document the local mode

1 files changed, 17 insertions, 0 deletions

diff --git a/doc.go b/doc.go
index 823ac2f..179a4f3 100644
--- a/doc.go
+++ b/doc.go
@@ -168,5 +168,22 @@ At present the bookpipeline has some silly limitations of file names for book
 pages to be recognised. This is something which will be fixed in due course.
   Pages that are to be fully processed: *[0-9]{4}.jpg$
   Pages that are to be wiped only: *[0-9]{6}(.bin)?.png$
+
+Local operation
+
+While bookpipeline was built with cloud based operation in mind, there is also
+a local mode that can be used to run OCR jobs from a single computer, with all
+the benefits of preprocessing, choosing the best threshold for each image,
+graph creation and so on that the pipeline provides.
+
+You can use this by passing the '-c local' flag to the core bookpipeline
+commands. Here is a simple example run:
+
+  booktopipeline -c local MyBook
+  bookpipeline -v -c local           # run until MyBook has finished processing
+  getpipelinebook -c local MyBook
+
+Note that the local mode is not as well tested as the core cloud modes; please
+report any bugs you find with it.
 */
 package bookpipeline