Update documentation

This commit is contained in:
Eike Kettner
2020-03-27 19:47:55 +01:00
parent f9d8016dc9
commit 75405dbcba
6 changed files with 46 additions and 28 deletions

View File

@ -3,8 +3,8 @@
[![Build Status](https://travis-ci.org/eikek/docspell.svg?branch=master)](https://travis-ci.org/eikek/docspell)
[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
# Docspell
# Docspell
Docspell is a personal document organizer. You'll need a scanner to
convert your papers into PDF files. Docspell can then assist in
@ -17,6 +17,8 @@ them later using the search feature. But adding this manually to each
document is a tedious task. What if most of it could be done
automatically?
It is provided as a REST server and a web application.
## How it works
Documents have two main properties: a correspondent (sender or
@ -41,6 +43,7 @@ must be maintained manually. But usually, this data doesn't grow as
fast as the documents. After a while there is a quite complete address
book and only once in a while it has to be revisited.
## Documentation
The [documentation site](https://eikek.github.io/docspell/) provides
@ -51,8 +54,12 @@ Check the feature list and the quickstart guide to try it out:
- [Features](https://eikek.github.io/docspell/features.html)
- [Quickstart](https://eikek.github.io/docspell/getit)
## Screenshots
Here are some (outdated) screenshots, for getting a first impression
of the web ui.
![screenshot-1](https://raw.githubusercontent.com/eikek/docspell/master/modules/microsite/src/main/resources/microsite/img/docspell-curate-1.jpg)
![screenshot-2](https://raw.githubusercontent.com/eikek/docspell/master/modules/microsite/src/main/resources/microsite/img/docspell-curate-2.jpg)
![screenshot-3](https://raw.githubusercontent.com/eikek/docspell/master/modules/microsite/src/main/resources/microsite/img/processing-queue.jpg)