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

# TLDraw for YunoHost

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

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

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

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

TLDraw is a tiny little drawing app.

### Features

- Very clean and nice UX
- Snappy and very low memory footprint on the server
- PWA ready
- Multiplayer mode (iFrame compatible)


**Shipped version:** 1.24.5~ynh3


**Demo:** https://tldraw.com

## Screenshots

![Screenshot of TLDraw](./doc/screenshots/TLDraw_screenshot.png)

## Documentation and resources

* Official app website: <https://tldraw.com>
* Official user documentation: <https://github.com/tldraw/tldraw/blob/main/guides/documentation.md>
* Official admin documentation: <https://github.com/tldraw/tldraw/blob/main/guides/documentation.md>
* Upstream app code repository: <https://github.com/tldraw/tldraw>
* YunoHost documentation for this app: <https://yunohost.org/app_tldraw>
* Report a bug: <https://github.com/YunoHost-Apps/tldraw_ynh/issues>

## Developer info

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

To try the testing branch, please proceed like that.

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

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