Skip to content

Commit b8c2bbe

Browse files
sylvinussampaccoud
authored andcommitted
✏️(readme) fix a few typos
Found a few errors after proof-reading the README
1 parent 1fd66d3 commit b8c2bbe

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Welcome to Docs! The open source document editor where your notes can become kno
1313
Chat on Matrix
1414
</a> - <a href="/docs/">
1515
Documentation
16-
</a> - <a href="#getting-started">
16+
</a> - <a href="#getting-started-">
1717
Getting started
1818
</a>
1919
</p>
@@ -60,7 +60,7 @@ $ docker compose -v
6060
docker compose version 1.27.4, build 40524192
6161
```
6262

63-
> ⚠️ You may need to run the following commands with sudo but this can be avoided by assigning your user to the `docker` group.
63+
> ⚠️ You may need to run the following commands with sudo but this can be avoided by adding your user to the `docker` group.
6464
6565
**Project bootstrap**
6666
The easiest way to start working on the project is to use GNU Make:
@@ -71,17 +71,16 @@ $ make bootstrap FLUSH_ARGS='--no-input'
7171

7272
This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this
7373

74-
command each time you are pulling code from the project repository to avoid dependency-releated or migration-releated issues.
74+
command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
7575

7676
Your Docker services should now be up and running 🎉
7777

7878
You can access to the project by going to <http://localhost:3000>.
7979

8080
You will be prompted to log in, the default credentials are:
8181

82-
```shellscript
82+
```
8383
username: impress
84-
8584
password: impress
8685
```
8786

@@ -172,7 +171,7 @@ docs
172171
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/)
173172

174173
### Gov ❤️ open source
175-
Docs is the result of a joint effort lead by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)).
174+
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/)).
176175

177176
We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).
178177

0 commit comments

Comments
 (0)