diff --git a/README.md b/README.md index cba4667c..1c6d7398 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,17 @@ Docs

- +

+ + + + PRs Welcome + GitHub commit activity + GitHub closed issues + + GitHub closed issues + +

Chat on Matrix @@ -16,12 +26,11 @@

- - # La Suite Docs : Collaborative Text Editing - Docs, where your notes can become knowledge through live collaboration. + + ## Why use Docs ❓ Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing. @@ -48,7 +57,9 @@ Available methods: Helm chart, Nix package In the works: Docker Compose, YunoHost -⚠️ For the PDF and Docx export Docs relies on XL packages from BlockNote licenced in AGPL-3.0. Please make sure you fulfill your [BlockNote licensing](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE) or [sponsorship](https://www.blocknotejs.org/about#partner-with-us) obligations. +⚠️ For the PDF and Docx export Docs relies on XL packages from BlockNote licenced in AGPL-3.0 which are not MIT compatible. +You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true, and that way you'll build an image of the application without the features that are not MIT compatible. +If you run Docs `PUBLISH_AS_MIT` set to false make sure you fulfill your [BlockNote licensing](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE) or [sponsorship](https://www.blocknotejs.org/about#partner-with-us) obligations. ## Getting started 🔧