diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..baf6da5 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,3 @@ +LICENSE +README.md +screenshot.png diff --git a/README.md b/README.md index 22e981b..c7bbd12 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # OCRmyPDFonWEB -Streamlit Web UI for OCRmyPDF +Streamlit Web UI for OCRmyPDF. Its codebase is tiny, so if you want to modify it, it should be straightforward. It is also stateless, making it easy to deploy. No volumes. No configuration. + +![screenshot](screenshot.png "Screenshot") + +## Requirements + +* docker + +## Usage + +``` +docker run --rm -p 127.0.0.1:8501:8501 razemio/ocrmypdfonweb +``` + +## Develop + +``` +docker build -t razemio/ocrmypdfonweb:dev . # Only needed after you changed requirements.txt +docker run --rm -it -p 127.0.0.1:8501:8501 -v ${PWD}/server.py:/app/server.py razemio/ocrmypdfonweb +``` + +Happy coding :) + +## FAQ + +### Why? + +To keep your non-tech significant other happy. The terminal can be a dark place for some people. + +### Why do you use OCRmyPDF version 12.7.2? +It is the last version which supports remove background. Which is somewhat impossible to find in normal PDF editors. Otherwise, OCRmyPDF works flawlessly, and I yet haven't found an issue which makes me want to upgrade. diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..965dc4f Binary files /dev/null and b/screenshot.png differ