[#52073] Update README with information about the spellchecker

antmicro · Dec 8, 2023 · 4f35380 · 4f35380
1 parent 3c9d5e6
commit 4f35380
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -128,6 +128,9 @@ Here are the props you can pass to the MystEditor component:
   - `username`
   - `room` - name of the room to join, users will see others in the same room
   - `color` - color of the cursor seen by other users
+- `spellcheckOpts` - Configuration for the spellchecker. If the value is *null* or *false* then the spellchecker will be disabled.
+  - `dict` *(default: "en_US")* - Name of the desired dictionary. For an example see `public/dictionaries/en_US`.
+  - `dictionaryPath` *(default: "/dictionaries")*  - Path to a folder with dictionaries. For an example see `public/dictionaries/`.
 
 ## License