Skip to content

Commit e4d0179

Browse files
authored
📝(doc) readme update (#974)
Added badges so people can assess the repo activity easily. Also update the paragraph about AGPL XL packages since this was merged : #911 --------- Signed-off-by: virgile-dev <[email protected]>
1 parent 9d3dfb6 commit e4d0179

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,17 @@
33
<img alt="Docs" src="/docs/assets/banner-docs.png" width="100%" />
44
</a>
55
</p>
6-
6+
<p align="center">
7+
<a href="https://github.com/suitenumerique/docs/stargazers/">
8+
<img src="https://img.shields.io/github/stars/suitenumerique/docs" alt="">
9+
</a>
10+
<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>
11+
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/suitenumerique/docs"/>
12+
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/suitenumerique/docs"/>
13+
<a href="https://github.com/suitenumerique/docs/blob/main/LICENSE">
14+
<img alt="GitHub closed issues" src="https://img.shields.io/github/license/suitenumerique/docs"/>
15+
</a>
16+
</p>
717
<p align="center">
818
<a href="https://matrix.to/#/#docs-official:matrix.org">
919
Chat on Matrix
@@ -16,12 +26,11 @@
1626
</a>
1727
</p>
1828

19-
<img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
20-
2129
# La Suite Docs : Collaborative Text Editing
22-
2330
Docs, where your notes can become knowledge through live collaboration.
2431

32+
<img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
33+
2534
## Why use Docs ❓
2635
Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.
2736

@@ -48,7 +57,9 @@ Available methods: Helm chart, Nix package
4857

4958
In the works: Docker Compose, YunoHost
5059

51-
⚠️ 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.
60+
⚠️ For the PDF and Docx export Docs relies on XL packages from BlockNote licenced in AGPL-3.0 which are not MIT compatible.
61+
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.
62+
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.
5263

5364
## Getting started 🔧
5465

0 commit comments

Comments
 (0)