diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000000000000000000000000000000000000..cbfc4f251f7be55e98135d162e9577e546dccc56
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,8 @@
+This module will generate the Pinyin short code(拼音简码) based on the entity label field.
+
+Code example:
+
+    $fields['pinyin'] = BaseFieldDefinition::create('pinyin_shortcode')
+      ->setLabel('拼音码')
+      ->setSetting('max_length', 16);
+