docs: plugin; renaming

2019-06-20 02:44:54 -07:00
parent 51ed381bfc
commit 9c4b1aeb8d
3 changed files with 37 additions and 14 deletions
@@ -0,0 +1,22 @@
+Plugins
+=======
+
+You can use plugins to customize the behavior of OCRmyPDF at certain points of interest.
+
+Currently, it is possible to:
+- override the decision for whether or not to perform OCR on a particular file
+- modify the image is about to be sent for OCR
+
+How plugins are imported
+------------------------
+
+Plugins are imported on demand, by the OCRmyPDF worker process that needs to use them.
+As such, plugins cannot share state with each other, and will be imported many times,
+once for each worker process.
+
+Plugins currently cannot override the same hook.
+
+How plugins are invoked
+-----------------------
+
+Plugins may be called from the command line: