Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
svera committed Jan 13, 2025
1 parent 86400ae commit 3104bae
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

A personal documents server, Coreander indexes the documents (EPUBs and PDFs with no DRM) that it finds in the passed folder, and provides a web interface to search and access them.

![Coreander home](home.png)
*Coreander home*
<figure>
<img src="home.png" alt="Coreander home" style="border: solid 1px">
<figcaption style="text-align: center"><i>Coreander home</i></figcaption>
</figure>

## Features
* Single binary with all dependencies included.
Expand Down Expand Up @@ -134,9 +136,17 @@ On first run, Coreander creates an admin user with the following credentials:

## Screenshots

![Search results](search-results.png)
*Search results*
![Document detail in dark mode](doc-detail.png)
*Document detail in dark mode*
![Reading interface](reading.png)
*Reading interface*
<figure style="margin-bottom: 2em">
<img src="search-results.png" alt="Coreander home" style="border: solid 1px;">
<figcaption style="text-align: center"><i>Coreander home</i></figcaption>
</figure>

<figure style="margin-bottom: 2em">
<img src="doc-detail.png" alt="Document detail in dark mode" style="border: solid 1px">
<figcaption style="text-align: center"><i>Document detail in dark mode</i></figcaption>
</figure>

<figure>
<img src="reading.png" alt="Reading interface" style="border: solid 1px">
<figcaption style="text-align: center"><i>Reading interfac</i></figcaption>
</figure>

0 comments on commit 3104bae

Please sign in to comment.