Update Readme.md
Change-Id: I3806223f3e8e6283608f5d833f69b67f342858a8
diff --git a/Readme.md b/Readme.md
index 034af3a..6ad1423 100644
--- a/Readme.md
+++ b/Readme.md
@@ -4,6 +4,38 @@
Reads CoNLL-U format from stdin and annotates emojis, emoticons, hashtags, URLs, email addresses, action words, @names, and Wikipedia emoji templates with their corresponding STTS-IBK POS tag (Beißwenger/Bartsch/Evert/Würzner 2016). Writes CoNLL-U format to stdout.
+For Unicode emojis (`EMOIMG`), the base emoji without skin tone modifiers
+is written to the LEMMA column and Unicode emoji metadata is added to the FEATS column:
+
+```tsv
+# text = 😂
+1 😂 😂 _ EMOIMG g=smileys_&_emotion|s=face_smiling|q=fully_qualified|v=E0.6|n=face_with_tears_of_joy _ _ _ _
+```
+
+The FEATS field encodes: `g` (group), `s` (subgroup), `q` (qualification status), `v` (Unicode version first introduced), `n` (emoji name – including skin tone). See <https://www.unicode.org/Public/UCD/latest/emoji/emoji-test.txt> for details.
+
+
+
+## Local Usage
+
+### Using npm/node
+
+```shell
+cat ./test/data/ndy.conllu | npx conllu-cmc
+```
+
+### Using standalone binary
+
+```shell
+korapxml2conllu kyc.zip | ./conllu2cmc
+```
+
+### Generate KorAP-XML zip with CMC annotations
+
+```shell
+korapxml2conllu kyc.zip | conllu2cmc -s | conllu2korapxml > kyc.cmc.zip
+```
+
## Docker Usage
```shell
@@ -20,34 +52,8 @@
docker run --rm korap/conllu-cmc --help
```
-## Local Usage
-
-### Using npm/node
-
-```shell
-korapxml2conllu kyc.zip | npx conllu-cmc
-```
-
-### Using standalone binary
-
-```shell
-korapxml2conllu kyc.zip | ./conllu2cmc
-```
-
-### Generate KorAP-XML zip with CMC annotations
-
-```shell
-korapxml2conllu kyc.zip | conllu2cmc -s | conllu2korapxml > kyc.cmc.zip
-```
-
## Installation
-### Docker (recommended)
-
-```shell
-docker pull korap/conllu-cmc
-```
-
### Pre-built Binaries
Download pre-built executables from the [Releases](https://github.com/KorAP/KorAP-CoNLL-U-CMC/releases) page:
@@ -81,6 +87,13 @@
Executables are created in `bin/linux/`, `bin/macos/`, and `bin/win/`.
+### Docker
+
+```shell
+docker pull korap/conllu-cmc
+```
+
+
## References
Beißwenger, Michael/Bartsch, Sabine/Evert, Stefan/Würzner, Kay-Michael (2016): EmpiriST 2015: A Shared Task on the Automatic Linguistic Annotation of Computer-Mediated Communication and Web Corpora. In: Proceedings of the 10th Web as Corpus Workshop. Berlin: Association for Computational Linguistics, S. 44–56. https://doi.org/10.18653/v1/W16-2606.