Update readme and fix a link

This commit is contained in:
Eike Kettner
2020-08-15 10:33:22 +02:00
parent 30d5abddd8
commit 569e19cc4f
3 changed files with 46 additions and 22 deletions

View File

@ -17,7 +17,9 @@ 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 document is a tedious task. What if most of it could be done
automatically? automatically?
It is provided as a REST server and a web application. It is provided as a REST server and a web application and is intended
to be self-hosted.
## How it works ## How it works
@ -44,7 +46,34 @@ 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. book and only once in a while it has to be revisited.
## Install ## Impressions
Checkout the short demo videos (<1min), present on the [project
page](https://docspell.org/#demos). Here are some screenshots:
![screenshot-1](https://raw.githubusercontent.com/eikek/docspell/master/website/site/content/docs/webapp/docspell-curate-1.jpg)
![screenshot-2](https://raw.githubusercontent.com/eikek/docspell/master/website/site/content/docs/webapp/docspell-curate-2.jpg)
## Try it
Docspell consists of several components. The probably quickest way to
get started is to use the docker setup as described in the [get started
page](https://docspell.org/#get-started). This is only three commands
away:
``` shell
git clone https://github.com/eikek/docspell
cd docspell
docker-compose up
```
Then go to `http://localhost:7880`, sign up and login. Use the same
name for collective and user for now. More on that can be found
[here](https://docspell.org/docs/intro/).
There are other ways, documented
[here](https://docspell.org/docs/install/quickstart/):
- Install the [provided](https://github.com/eikek/docspell/releases) - Install the [provided](https://github.com/eikek/docspell/releases)
`deb` file at your debian based system. `deb` file at your debian based system.
@ -54,26 +83,24 @@ book and only once in a while it has to be revisited.
- Using the [nix](https://nixos.org/nix) package manager as [described - Using the [nix](https://nixos.org/nix) package manager as [described
here](https://docspell.org/docs/install/installing/#nix). A NixOS here](https://docspell.org/docs/install/installing/#nix). A NixOS
module is available, too. module is available, too.
- Using Docker, as [described
here](https://docspell.org/docs/install/installing/#docker).
## Documentation ## Documentation
The [documentation site](https://docspell.org) provides more The [project page](https://docspell.org) has lots of information on
information. how to [use and setup](https://docspell.org/docs) docspell.
Check the feature list and the quickstart guide to try it out:
- [Features](https://docspell.org/#feature-selection)
- [Quickstart](https://docspell.org/#get-started)
## Screenshots ## Contributions
Here are some (outdated) screenshots, for getting a first impression Feedback and other contributions are very welcome! There is now a
of the web ui. [gitter room](https://gitter.im/eikek/docspell) for quick questions.
You can [open an issue](https://github.com/eikek/docspell/issues/new)
for questions, problems and other feedback; or make a mail to
`info [at] docspell.org`.
![screenshot-1](https://raw.githubusercontent.com/eikek/docspell/master/screenshots/search-view.png)
![screenshot-2](https://raw.githubusercontent.com/eikek/docspell/master/website/site/content/docs/webapp/docspell-curate-2.jpg) ## License
![screenshot-3](https://raw.githubusercontent.com/eikek/docspell/master/website/site/content/docs/webapp/processing-queue.jpg)
Docspell is free software, distributed under the [GPLv3 or
later](https://spdx.org/licenses/GPL-3.0-or-later.html).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 252 KiB

View File

@ -13,13 +13,11 @@ getStarted version =
"""Docspell consists of several components. The easiest way to get started is probably to use docker and """Docspell consists of several components. The easiest way to get started is probably to use docker and
[docker-compose](https://docs.docker.com/compose/).""" [docker-compose](https://docs.docker.com/compose/)."""
, Markdown.toHtml [] , Markdown.toHtml []
("""1. Clone the github repository """1. Clone the github repository
```bash ```bash
$ git clone https://github.com/eikek/docspell $ git clone https://github.com/eikek/docspell
``` ```
Alternatively, [download](https://github.com/eikek/docspell/archive/v""" Alternatively, [download](https://github.com/eikek/docspell/archive/master.zip) the sources and extract the zip file.
++ version
++ """.zip) the sources and extract the zip file.
2. Change into the `docker` directory: 2. Change into the `docker` directory:
```bash ```bash
$ cd docspell/docker $ cd docspell/docker
@ -46,7 +44,6 @@ getStarted version =
The directory contains a file `docspell.conf` that you can The directory contains a file `docspell.conf` that you can
[modify](docs/configure) as needed. [modify](docs/configure) as needed.
""" """
)
] ]
, div [ class "content container" ] , div [ class "content container" ]
[ div [ class "notification is-info is-light" ] [ div [ class "notification is-info is-light" ]