lychee_ynh/README.md

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->

# Lychee for YunoHost

[![Integration level](https://dash.yunohost.org/integration/lychee.svg)](https://dash.yunohost.org/appci/app/lychee) ![Working status](https://ci-apps.yunohost.org/ci/badges/lychee.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/lychee.maintain.svg)

[![Install Lychee with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=lychee)

*[Read this README is other languages.](./ALL_README.md)*

> *This package allows you to install Lychee quickly and simply on a YunoHost server.*  
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*

## Overview

Lychee is a free photo-management tool, which runs on your server or web-space. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely. 

**Shipped version:** 5.1.2~ynh1

**Demo:** <https://lycheeorg.github.io/demo/>

## Screenshots

![Screenshot of Lychee](./doc/screenshots/screenshot.jpg)

## Documentation and resources

- Official app website: <https://lycheeorg.github.io/>
- Official admin documentation: <https://lycheeorg.github.io/docs/>
- Upstream app code repository: <https://github.com/LycheeOrg/Lychee>
- YunoHost Store: <https://apps.yunohost.org/app/lychee>
- Report a bug: <https://github.com/YunoHost-Apps/lychee_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/lychee_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/lychee_ynh/tree/testing --debug
or
sudo yunohost app upgrade lychee -u https://github.com/YunoHost-Apps/lychee_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>