Docker: support for user defined sentences (#116)

Author: tilusnet

README.Docker.md

@@ -8,9 +8,9 @@ Start a container with:
 
 Your application will be available at http://localhost:8000.
 
-### Customise Wordlist
+### Customise Wordlists and Sentences
 
-You might want to run HanziGraph on your own filtered wordlist instead of the full dictionary provided.
+You might want to run HanziGraph on your own filtered wordlists instead of the full dictionary provided.
 
 For this, create a `wordlist.json` file containing the array of your words:
 
@@ -23,13 +23,40 @@ For this, create a `wordlist.json` file containing the array of your words:
 ]
 ```
 
-Then, in `compose.yaml` add a new bind mount to your custom wordlist by adapting `YOUR-PATH-TO`:
+Then, in `compose.yaml` add a new bind mount to your custom wordlist by adapting `YOUR-PATH-TO` and `TARGET-CHARSET`.    
+`TARGET-CHARSET` should be one of `simplified`, `traditional`, `hsk` or `cantonese`.
 
 ```yaml
     ...
     volumes:
       - "<YOUR-PATH-TO>/wordlist.json\
-        :/usr/src/app/public/data/simplified/wordlist.json\
+        :/usr/src/app/public/data/<TARGET-CHARSET>/wordlist.json\
+        :ro"
+    ...
+```
+
+Similarly, you can customise the available sentences too. Create a `sentences.json` file containing an array with 
+elements as the one below. The Chinese translations are split into meaningful words to guide segmentation.
+
+```json
+    {
+        "en": "Guilin's sceneries are the most beautiful ones under the heaven.",
+        "zh": [
+            "桂林山水",
+            "甲天下",
+            "。"
+        ],
+        "pinyin": "Gui4lin2 shan1shui3 jia3 tian1xia4."
+    },
+```
+
+Just like with wordlists, activate your custom sentences:
+
+```yaml
+    ...
+    volumes:
+      - "<YOUR-PATH-TO>/sentences.json\
+        :/usr/src/app/public/data/<TARGET-CHARSET>/sentences.json\
         :ro"
     ...
 ```

compose.yaml

@@ -7,8 +7,12 @@ services:
       NODE_ENV: production
     ports:
       - 8000:8000
+# Uncomment volumes below for custom wordlists and sentences - see README.Docker.md for details:
 #    volumes:
 #      - "<YOUR-PATH-TO>/wordlist.json\
 #        :/usr/src/app/public/data/simplified/wordlist.json\
 #        :ro"
+#      - "<YOUR-PATH-TO>/sentences.json\
+#        :/usr/src/app/public/data/simplified/sentences.json\
+#        :ro"