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.

### 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 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>
First commit 2023-07-09 15:30:42 +02:00			`<!--`
			`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.`
			`-->`

Auto-update README 2023-07-09 15:30:47 +02:00			`# Directory Lister for YunoHost`
First commit 2023-07-09 15:30:42 +02:00
Auto-update README 2023-07-09 15:30:47 +02:00			`[![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)`
First commit 2023-07-09 15:30:42 +02:00
			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2023-07-09 15:30:47 +02:00			`> *This package allows you to install Directory Lister quickly and simply on a YunoHost server.`
First commit 2023-07-09 15:30:42 +02:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`

			`## Overview`

Auto-update README 2023-07-09 15:30:47 +02:00			`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.`

First commit 2023-07-09 15:30:42 +02:00			`### Features`

Auto-update README 2023-09-01 20:21:53 +02:00			`- Simple installation`
			`- Light and dark themes`
			`- Custom sort ordering`
			`- File search`
			`- File hashes`
			`- Readme rendering`
			`- Zip downloads`
			`- Multi-lingual`
First commit 2023-07-09 15:30:42 +02:00
Auto-update README 2023-07-09 15:30:47 +02:00			`Shipped version: 3.12.3~ynh1`
First commit 2023-07-09 15:30:42 +02:00
Auto-update README 2023-07-09 15:30:47 +02:00			`Demo: https://demo.directorylister.com/`
First commit 2023-07-09 15:30:42 +02:00
			`## Screenshots`

Auto-update README 2023-07-09 15:30:47 +02:00			`![Screenshot of Directory Lister](./doc/screenshots/Screenshot.png)`
First commit 2023-07-09 15:30:42 +02:00
			`## Documentation and resources`

Auto-update README 2023-07-09 15:30:47 +02:00			`* 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>`
First commit 2023-07-09 15:30:42 +02:00
			`## Developer info`

Auto-update README 2023-07-09 15:30:47 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/directorylister_ynh/tree/testing).`
First commit 2023-07-09 15:30:42 +02:00
			`To try the testing branch, please proceed like that.`

			``` bash
Auto-update README 2023-07-09 15:30:47 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/directorylister_ynh/tree/testing --debug`
First commit 2023-07-09 15:30:42 +02:00			`or`
Auto-update README 2023-07-09 15:30:47 +02:00			`sudo yunohost app upgrade directorylister -u https://github.com/YunoHost-Apps/directorylister_ynh/tree/testing --debug`
First commit 2023-07-09 15:30:42 +02:00			```

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