From e4d0179bbeef11685824e27c98cff1d6a6eb5619 Mon Sep 17 00:00:00 2001
From: virgile-dev <virgile.deville@beta.gouv.fr>
Date: Fri, 16 May 2025 19:48:57 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(doc)=20readme=20update=20(#974)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Added badges so people can assess the repo activity easily.
Also update the paragraph about AGPL XL packages since this was merged :
https://github.com/suitenumerique/docs/pull/911

---------

Signed-off-by: virgile-dev <virgile.deville@beta.gouv.fr>
---
 README.md | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index cba4667c..1c6d7398 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,17 @@
     <img alt="Docs" src="/docs/assets/banner-docs.png" width="100%" />
   </a>
 </p>
-
+<p align="center">
+  <a href="https://github.com/suitenumerique/docs/stargazers/">
+    <img src="https://img.shields.io/github/stars/suitenumerique/docs" alt="">
+  </a>
+  <a href='https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md'><img alt='PRs Welcome' src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields'/></a>
+  <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/suitenumerique/docs"/>
+  <img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/suitenumerique/docs"/>
+  <a href="https://github.com/suitenumerique/docs/blob/main/LICENSE">
+    <img alt="GitHub closed issues" src="https://img.shields.io/github/license/suitenumerique/docs"/>
+  </a>    
+</p>
 <p align="center">
   <a href="https://matrix.to/#/#docs-official:matrix.org">
     Chat on Matrix
@@ -16,12 +26,11 @@
   </a>
 </p>
 
-<img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
-
 # La Suite Docs : Collaborative Text Editing
-
 Docs, where your notes can become knowledge through live collaboration.
 
+<img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
+
 ## 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 🔧