From a75cbb79d814321fd03b5be94e0bb712046560ef Mon Sep 17 00:00:00 2001 From: wezbyte_admin Date: Thu, 18 Feb 2021 17:41:53 +0000 Subject: [PATCH] Update 'README.md' Adds intro --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb58995..91e1a76 100644 --- a/README.md +++ b/README.md @@ -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