From 62750312d1da2854fa12ea2a84b36aa2873eeb30 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 11 Jun 2023 16:57:46 +0000 Subject: [PATCH] Auto-update README --- README.md | 22 +--------------------- README_fr.md | 22 +--------------------- 2 files changed, 2 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index e2508da..78b82f6 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/README_fr.md b/README_fr.md index 5343ba0..370915e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -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 :