Skip to content

Commit 8b2c8b8

Browse files
committed
update readme
1 parent 18dce5e commit 8b2c8b8

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11

2-
Papermerge - Core
3-
###################
2+
Papermerge Core
3+
################
44

5-
Papermerge Core contains essential functionality shared among different flavors of
6-
Papermerge Document Management System (DMS).
5+
Papermerge Core reusable Django apps are the heart of Papermerge project. It is
6+
(re)used across different flavors of Papermerge Document Management System
7+
(DMS). It contains the core functionality, models and API used throughout
8+
Papermerge ecosystem.
79

10+
Technically speaking, it contains following django apps:
11+
12+
* papermerge.core - the epicenter of papermerge project which defines main models
13+
* papermerge.contrib.admin - user interface is defined here
14+
* papermerge.search - unified search API
815

916
What is Papermerge?
1017
~~~~~~~~~~~~~~~~~~~
@@ -19,3 +26,5 @@ index it and make it searchable. You will be able to quickly find any
1926
(scanned!) document using full text search capabilities.
2027

2128
Papermerge is perfect tool to manage PDF, JPEG, TIFF and PNG formats.
29+
30+
.. figure:: img/screenshot.png

img/screenshot.png

174 KB
Loading

0 commit comments

Comments
 (0)