diff --git a/README.md b/README.md
index 8d6c88c8..a1bf9e6c 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@ Welcome to Docs! The open source document editor where your notes can become kno
## Why use Docs β
+
Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.
### Write
@@ -33,23 +34,31 @@ Docs is a collaborative text editor designed to address common challenges in kno
* β¨ Save time thanks to our AI actions (generate, sum up, correct, translate)
### Collaborate
-* π€ Collaborate in realtime with your team mates
-* π Granular access control to keep your information secure and shared with the right people
+* π€ Collaborate with your team in real time
+* π Granular access control to ensure your information is secure and only shared with the right people
* π Professional document exports in multiple formats (.odt, .doc, .pdf) with customizable templates
-* π Built-in wiki functionality to transform your team's collaborative work into organized knowledge `ETA 02/2025`
+* π Built-in wiki functionality to turn your team's collaborative work into organized knowledge `ETA 02/2025`
### Self-host
* π Easy to install, scalable and secure alternative to Notion, Outline or Confluence
## Getting started π§
+
### Test it
+
Test Docs on your browser by logging in on this [environment](https://impress-preprod.beta.numerique.gouv.fr/docs/0aa856e9-da41-4d59-b73d-a61cb2c1245f/)
+
```
email: test.docs@yopmail.com
password: I'd<3ToTestDocs
```
+
### Run it locally
+
+> β οΈ Running Docs locally using the methods described below is for testing purposes only. It is based on building Docs using Minio as the S3 storage solution: if you want to use Minio for production deployment of Docs, you will need to comply with Minio's AGPL-3.0 licence.
+
**Prerequisite**
+
Make sure you have a recent version of Docker and [Docker Compose](https://docs.docker.com/compose/install) installed on your laptop:
```shellscript
@@ -65,15 +74,14 @@ docker compose version 1.27.4, build 40524192
> β οΈ You may need to run the following commands with sudo but this can be avoided by adding your user to the `docker` group.
**Project bootstrap**
+
The easiest way to start working on the project is to use GNU Make:
```shellscript
$ make bootstrap FLUSH_ARGS='--no-input'
```
-This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this
-
-command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
+This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
Your Docker services should now be up and running π
@@ -126,6 +134,7 @@ $ make help
```
**Django admin**
+
You can access the Django admin site at
.
@@ -137,17 +146,21 @@ $ make superuser
```
## Feedback πββοΈπββοΈ
+
We'd love to hear your thoughts and hear about your experiments, so come and say hi on [Matrix](https://matrix.to/#/#docs-official:matrix.org).
## Roadmap
+
Want to know where the project is headed? [πΊοΈ Checkout our roadmap](https://github.com/orgs/numerique-gouv/projects/13/views/11)
## Licence π
+
This work is released under the MIT License (see [LICENSE](https://github.com/suitenumerique/docs/blob/main/LICENSE)).
While Docs is a public driven initiative our licence choice is an invitation for private sector actors to use, sell and contribute to the project.
## Contributing π
+
This project is intended to be community-driven, so please, do not hesitate to [get in touch](https://matrix.to/#/#docs-official:matrix.org) if you have any question related to our implementation or design decisions.
You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs).
@@ -169,10 +182,13 @@ docs
```
## Credits β€οΈ
+
### Stack
-Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [MinIO](https://min.io/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/)
+
+Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/).
### Gov β€οΈ open source
+
Docs is the result of a joint effort led by the French π«π·π₯ ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German π©πͺπ₯¨ governments ([ZenDiS](https://zendis.de/)).
We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).