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)

*[Read this README is other languages.](./ALL_README.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.

### Features

- Simple installation
- Light and dark themes
- Custom sort ordering
- File search
- File hashes
- Readme rendering
- Zip downloads
- Multi-lingual


**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 Store: <https://apps.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>