YunoHost-Apps/tldraw_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/tldraw_ynh.git synced 2024-09-03 20:35:54 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2023-06-11 16:57:46 +00:00
parent 8788b123e4
commit 62750312d1
2 changed files with 2 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -26,7 +26,7 @@ TLDraw is a tiny little drawing app.
- Multiplayer mode (iFrame compatible)
**Shipped version:** 1.24.5~ynh2
**Shipped version:** 1.24.5~ynh3
**Demo:** https://tldraw.com
@ -34,26 +34,6 @@ TLDraw is a tiny little drawing app.
![Screenshot of TLDraw](./doc/screenshots/TLDraw_screenshot.png)
## Disclaimers / important information
* TLDraw can't be installed on a subpath, and needs a fully dedicated domain
* The multiplayer mode requires Liveblocks API keys (Public and Secret)
* You can get some for free at liveblocks.io
* Be **very careful** though, and keep in mind that by doing so, all your multiplayer rooms data will be stored on livestocks.io SaaS servers, and **NOT** on your server
* Multiplayer mode is completely optional and you don't have to use it
* If API keys are not provided, it will be automatically deactivated
* TLDraw will not take a lot of disk or memory space while running.
* **However**, you will need at least 2.5GB of RAM and 5GB of disk space during installation time
* The build can be quite long, be patient!
* TLDraw offers all functionnalities (including multiplayer) for free at tldraw.com
* However, they have restricted the use of multiplayer mode within an iFrame, which could be a problem
* TLDraw YunoHost app is patching that restriction so that you can use multiplayer mode within an iFrame as before
* It could be possible to self-host a multiplayer layer in the future. Some projects have been launched, based on YJS library, such as https://github.com/nimeshnayaju/yjs-tldraw, but sadly none of them is mature enough to be included here.
* Obviously, as soon as multiplayer could be enabled without going through Liveblocks SaaS servers, the app will be updated accordingly
## Documentation and resources
* Official app website: <https://tldraw.com>

22
README_fr.md
View file

@ -26,7 +26,7 @@ TLDraw is a tiny little drawing app.
- Multiplayer mode (iFrame compatible)
**Version incluse :** 1.24.5~ynh2
**Version incluse :** 1.24.5~ynh3
**Démo :** https://tldraw.com
@ -34,26 +34,6 @@ TLDraw is a tiny little drawing app.
![Capture d’écran de TLDraw](./doc/screenshots/TLDraw_screenshot.png)
## Avertissements / informations importantes
* TLDraw can't be installed on a subpath, and needs a fully dedicated domain
* The multiplayer mode requires Liveblocks API keys (Public and Secret)
* You can get some for free at liveblocks.io
* Be **very careful** though, and keep in mind that by doing so, all your multiplayer rooms data will be stored on livestocks.io SaaS servers, and **NOT** on your server
* Multiplayer mode is completely optional and you don't have to use it
* If API keys are not provided, it will be automatically deactivated
* TLDraw will not take a lot of disk or memory space while running.
* **However**, you will need at least 2.5GB of RAM and 5GB of disk space during installation time
* The build can be quite long, be patient!
* TLDraw offers all functionnalities (including multiplayer) for free at tldraw.com
* However, they have restricted the use of multiplayer mode within an iFrame, which could be a problem
* TLDraw YunoHost app is patching that restriction so that you can use multiplayer mode within an iFrame as before
* It could be possible to self-host a multiplayer layer in the future. Some projects have been launched, based on YJS library, such as https://github.com/nimeshnayaju/yjs-tldraw, but sadly none of them is mature enough to be included here.
* Obviously, as soon as multiplayer could be enabled without going through Liveblocks SaaS servers, the app will be updated accordingly
## Documentations et ressources
* Site officiel de l’app : <https://tldraw.com>