directorylister_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.
-->

# Directory Lister for YunoHost

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

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

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Directory Lister 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

Directory Lister is the easiest way to expose the contents of any web-accessible folder for browsing and sharing. With a zero configuration, drag-and-drop installation you'll be up and running in less than a minute.

Directory Lister is created and maintained by Chris Kankiewicz (@PHLAK) with help from community contributions.

### Features

    Simple installation allows you to be up and running in less than a minute.
    Light and dark themes to suit your professional needs or personal style.
    Custom sort ordering gives you control of the ordering of your files/folders.
    File search helps you locate the files you need quickly and efficiently.
    File hashes instill confidence when downloading files through verification.
    Readme rendering allows exposing the contents of READMEs directly on the page.
    Zip downloads for fetching an entire directory of files in a single action.
    Multi-lingual support brings Directory Lister to the language of your choice.


**Shipped version:** 3.12.3~ynh1

**Demo:** https://demo.directorylister.com/

## Screenshots

![Screenshot of Directory Lister](./doc/screenshots/Screenshot.png)

## Documentation and resources

* Official app website: <https://www.directorylister.com/>
* Official admin documentation: <https://docs.directorylister.com/>
* Upstream app code repository: <https://github.com/DirectoryLister/DirectoryLister>
* YunoHost documentation for this app: <https://yunohost.org/app_directorylister>
* Report a bug: <https://github.com/YunoHost-Apps/directorylister_ynh/issues>

## Developer info

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

To try the testing branch, please proceed like that.

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

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