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

# PairDrop for YunoHost

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

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

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

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

PairDrop is a sublime alternative to AirDrop that works on all platforms.

### Features

- File Sharing on your local network
	- Send images, documents or text via peer to peer connection to devices on the same local network.
- Internet Transfers
	- Join temporary public rooms to transfer files easily over the internet!
- Web-Application
	- As it is web based, it runs on all devices.


**Shipped version:** 1.10.7~ynh2

**Demo:** <https://pairdrop.net/>

## Screenshots

![Screenshot of PairDrop](./doc/screenshots/pairdrop_screenshot_desktop.png)

## Documentation and resources

- Official app website: <https://pairdrop.net/>
- Official admin documentation: <https://github.com/babstar99/PairDrop/blob/master/docs/host-your-own.md>
- Upstream app code repository: <https://github.com/babstar99/PairDrop>
- YunoHost Store: <https://apps.yunohost.org/app/pairdrop>
- Report a bug: <https://github.com/YunoHost-Apps/pairdrop_ynh/issues>

## Developer info

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

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

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

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