Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.

Commit

Permalink
Added a screenshot and cleaned things up a bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
danielquinn committed Feb 16, 2016
1 parent 5de4951 commit bbe7a02
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
Paperless
#########

.. image:: https://badges.gitter.im/danielquinn/paperless.svg
:alt: Join the chat at https://gitter.im/danielquinn/paperless
:target: https://gitter.im/danielquinn/paperless?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|Documentation|
|Chat|

Scan, index, and archive all of your paper documents

Expand Down Expand Up @@ -33,7 +31,12 @@ How it Works
like with it. You can even print it and send it as if it's the original.
In most cases, no one will care or notice.

.. _this one: http://www.brother.ca/en-CA/Scanners/11/ProductDetail/ADS1500W?ProductDetail=productdetail
Here's what you get:

.. image:: docs/_static/screenshot.png
:alt: The before and after
:target: docs/_static/screenshot.png


Stability
=========
Expand Down Expand Up @@ -67,23 +70,12 @@ Imagemagick > Pillow > PyOCR > Tesseract > text. It's not ideal, but
apparently, Pillow lacks the ability to read PDFs, and PyOCR requires a Pillow
object, so we're sort of stuck.

.. _ImageMagick: http://imagemagick.org/
.. _Tesseract: https://github.com/tesseract-ocr
.. _GNU Privacy Guard: https://gnupg.org/
.. _Python 3: https://python.org/
.. _Pillow: https://pypi.python.org/pypi/pillowfight/
.. _PyOCR: https://github.com/jflesch/pyocr
.. _Django: https://djangoproject.org/
.. _Python-GNUPG: http://pythonhosted.org/python-gnupg/


Documentation
=============

It's all available on `ReadTheDocs`_.

.. _ReadTheDocs: https://paperless.readthedocs.org/


Important Note
==============
Expand All @@ -97,6 +89,20 @@ means that paperless should never be run on an untrusted host. Instead, I
recommend that if you do want to use it, run it locally on a server in your own
home.

.. _this one: http://www.brother.ca/en-CA/Scanners/11/ProductDetail/ADS1500W?ProductDetail=productdetail
.. _ImageMagick: http://imagemagick.org/
.. _Tesseract: https://github.com/tesseract-ocr
.. _GNU Privacy Guard: https://gnupg.org/
.. _Python 3: https://python.org/
.. _Pillow: https://pypi.python.org/pypi/pillowfight/
.. _PyOCR: https://github.com/jflesch/pyocr
.. _Django: https://djangoproject.org/
.. _Python-GNUPG: http://pythonhosted.org/python-gnupg/
.. _ReadTheDocs: https://paperless.readthedocs.org/
.. |Documentation| image:: https://readthedocs.org/projects/paperless/badge/?version=latest
:alt: Read the documentation at https://paperless.readthedocs.org/
:target: https://paperless.readthedocs.org/
.. |Chat| image:: https://badges.gitter.im/danielquinn/paperless.svg
:alt: Join the chat at https://gitter.im/danielquinn/paperless
:target: https://gitter.im/danielquinn/paperless?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

0 comments on commit bbe7a02

Please sign in to comment.