Update 'README.md'
Adds intro
This commit is contained in:
@@ -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
|
## Installation
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user