Update 'README.md'

Adds intro
2021-02-18 17:41:53 +00:00
parent 83b9b70ffe
commit a75cbb79d8
1 changed files with 7 additions and 1 deletions
@@ -1,4 +1,10 @@
-# Text Formatter Demo Module
+# Text Field Formatter Demo Module
+
+Provides three cusotm text field formatters for textfields.
+
+1. Rot13 - Prints the field value with the ROT13 encoding(https://en.wikipedia.org/wiki/ROT13). For example, "Lorem Ipsum" would become "Yberz Vcfhz".
+1. Slugify - Converts and prints the field value into a slug using the cocur/slugify package.
+1. Tooltip - Shows a tooltip when you hover on the printed field value. Uses qTip2 Javascript library (https://github.com/qTip2/qTip2) to display the tooltip. Tooltip text are randomly generated sentences.

 ## Installation